🧿Introduction of the Eye- AI API

Authentication

The Eye AI API uses API keys for authentication. Visit the API Keys page to retrieve the API key you will use in your requests.

Remember that your API key is a secret! Do not share it with others or expose it in any client-side code (browsers, applications). Production requests should be routed through your own back-end server, where your API key can be loaded securely from an environment variable or key management service.

All API requests must include your API key in an Authorization HTTP header as follows:

Authorization: Bearer YOUR_API_KEY

Requesting Organization For users who belong to multiple organizations, you can pass a header to specify which organization is used for an API request. The usage of these API requests will be counted in the subscription quota of the specified organization.

Example curl command:

Curl https://api.eye-ai.com/v1/models \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'eye-ai-Organization: YOUR_ORG_ID'

Example with the Eye-AI Python package:

import os
import Eye-AI
Eye-AI.organization = "YOUR_ORG_ID"
Eye-AI.api_key = os.getenv("Eye-AI_API_KEY")
Eye-AI.Model.list()

Example with the Eye-AI Node.js package:

import { Configuration, eYE-ai-API} from "eye-ai";
const configuration = new Configuration({
    organization: "YOUR_ORG_ID",
    apiKey: process.env.EYE-AI_API_KEY,
});
const eye-ai  = new Eye-AI-Api(configuration);
const response = await Eye-AI.listEngines();