You can use the API to interact programmatically with your projects and pipelines. The API follows a RESTful architecture, which is characterized by several key attributes:Documentation Index
Fetch the complete documentation index at: https://docs.maia.ai/llms.txt
Use this file to discover all available pages before exploring further.
- A resource-based URL format.
- When interacting with the API, use form-encoded data.
- Responses from the API are in JSON format.
- The API uses the standard HTTPS port 443 and HTTP response codes.
- The API employs standard authentication methods, including the use of bearer tokens, to secure access. It also follows standard HTTP verbs (for example, GET, POST, PATCH, and DELETE) for consistent and familiar interaction with the API.
Prerequisites
Create a account or sign in.Base URL
EU server:Your account needs to be in the same region as the endpoint server.
Authentication
The API supports authentication via OAuth or bearer token. To authenticate using a bearer token, you should provide a token obtained through API credentials. For detailed instructions on the authentication process, read Authenticate to the Maia API.Rate limits
The API has a fixed rate limit, which may cause an HTTP error if you attempt a large number of concurrent endpoint calls. The HTTP error code returned if the rate limit is exceeded is429 Too Many Requests. The Retry-After HTTP response header will indicate how long you need to wait before making a subsequent request.
The API rate limit is 1000 requests per minute.
If you receive a rate limit error from the API, try reconfiguring your scripts or pipelines to make use of sequential endpoint calls. In a pipeline calling the API, consider including a Retry component with the Retry delay property set to an appropriate value. We recommend a setting of Long delay with backoff, with at least five retries.
