API Calls
The Halluminate Web API is a restful API with different endpoints which return JSON data objects about users and your LLM evaluations.
Base URL
Halluminate's base address for the API is: https://api.halluminate.ai
Authorization
Every request to the Halluminate Web API requires authorization. Authorization is the procedure which enables a user to access Halluminate's API features (i.e. you will be unable to send requests to the Halluminate Web API if you do not successfully authorize yourself by signing up for an API key on our website Halluminate.)
Types of requests
Data resources are obtained using standard HTTP requests to an API endpoint. The Halluminate Web API uses the following HTTP operations:
- Name
GET- Type
- HTTP Request Method
- Description
Fetches resources
- Name
POST- Type
- HTTP Request Method
- Description
Creates resources
- Name
PUT- Type
- HTTP Request Method
- Description
Updates or replaces existing resources
- Name
DELETE- Type
- HTTP Request Method
- Description
Deletes resources
Responses: HTTP Status Codes
When making an HTTP request to the Halluminate API, you will receive a JSON data object and one of the following status codes:
- Name
200- Type
- HTTP Status Code
- Description
"Ok" - The request succeeded. You will be able to see the returned resources in the response body and headers of the request.
- Name
201- Type
- HTTP Status Code
- Description
"Created" - The request has been satisfied, and your data resource has been created.
- Name
204- Type
- HTTP Status Code
- Description
"No Content" - The request has been satisfied, however, your request will not return any data resources.
- Name
400- Type
- HTTP Status Code
- Description
"Bad Request" - The request was not satisfied by the server due to an issue on the user's side. Typically, this is because of incorrect request syntax.
- Name
401- Type
- HTTP Status Code
- Description
"Unauthorized" - The request was not accepted because we require user authorization credentials, which were either not sent in the request or refused.
- Name
403- Type
- HTTP Status Code
- Description
"Forbidden" - The request was accepted by the server, however, the server is refusing to satisfy the request.
- Name
404- Type
- HTTP Status Code
- Description
"Not Found" - The request was not satisfied because the server could not find the desired resource.
- Name
500- Type
- HTTP Status Code
- Description
"Internal Server Error" - The request was not satisifed due to an issue within the server. If the error persists and you are unable to resolve it, please contact us at contact@halluminate.ai.
Responses: Errors
When requesting Halluminate's API endpoints, you may be returned a response error which is structured as follows:
- Name
detail- Type
- string
- Description
A general, high-level description of the error.
- Name
error_message- Type
- string
- Description
A detailed description of the error.
Example Request
curl -X GET https://api.halluminate.ai/me/ \
-H "Authorization: Token "Example Response Error
{
"detail": "Authentication credentials were not provided."
}