API REQUESTS

Authentication and common API request information

Base URL

The base URL for every request is:

https://api.eyelevel.ai/{VERSION}/partner

Current Version

The current API version is v1. Therefore, the base URL for a v1 API request is:

https://api.eyelevel.ai/v1/partner

Authentication

Every API request must include a HEADER containing your partner API key and a HEADER defining the content type of your request. In v1, JSON is the only accepted content type.

EXAMPLE QUERY

GET https://api.eyelevel.ai/v1/partner/:query

Path Parameters

Name	Type	Description
query	string	API request type

Headers

Name	Type	Description
X-API-KEY	string	EyeLevel partner API key
Content-Type	string	application/json

400 API request was in an invalid format or was missing a required parameter

{
    "message": "ERROR MESSAGE"
}

401 API key was missing from the HEADER or was not an authorized partner API key

{
    "message": "ERROR MESSAGE"
}

403 API request query does not exist

{
    "message": "ERROR MESSAGE"
}

500 An error occurred within the EyeLevel system

{
    "message": "ERROR MESSAGE"
}