This documentation provides guidelines on how to access and use the API. Please read all sections carefully before integrating.
Server#
| Environment | Base URL |
|---|
| Staging | - |
| Production | - |
Use the appropriate base URL based on your purpose. Staging is intended for testing and development, while production is for live systems.Every request to the API must include the following headers:| Header Name | Type | Required | Description |
|---|
x-request-id | string | ✅ | A unique ID for each request, generated on the client side. Useful for tracing and debugging. |
x-client-id | string | ✅ | A unique ID for each client. If you don’t have a client_id, please contact the admin to obtain one. |
x-ai-code | string | ⚠️ | Optional. Some endpoints may require an x-ai-code for additional validation. Check the endpoint documentation. |
Authorization | string | ✅ | Authorization token using the Bearer scheme. The token is generated from Base64(public_key:private_key). Both keys can be obtained from the admin. |
Authorization#
The API uses the Bearer Token scheme for authorization.
The token format is the Base64 encoding of public_key:private_key.Important: Never store public_key and private_key in frontend code or any public repository.