REST API
Integrate AI ARTEDUSA with your existing tools via our REST API: available endpoints, JWT authentication, code examples, and rate limits.
API OVERVIEW
AI ARTEDUSA exposes a REST API built with FastAPI, allowing you to integrate your AI call centre with your existing tools. The OpenAPI schema describes all endpoints.
The API uses JSON format for requests and responses, with standard HTTP status codes.
AUTHENTICATION
The API authenticates via the session token:
- Session JWT: include the token in the Authorization: Bearer <token> header. This token, obtained at login, authenticates all your requests.
MAIN ENDPOINTS
Here are the available endpoint categories:
- GET /api/v1/tenants/{tenant_id}/calls: list of calls (pagination + channel/date/search filters)
- GET /api/v1/tenants/{tenant_id}/calls/{call_id}: call details (transcript, summary, metadata)
- GET /api/v1/tenants/{tenant_id}/knowledge: list of knowledge base documents
- POST /api/v1/tenants/{tenant_id}/knowledge: add a document
- DELETE /api/v1/tenants/{tenant_id}/knowledge/{item_id}: delete a document
- POST /api/v1/tenants/{tenant_id}/knowledge/sync: launch knowledge base synchronisation
- GET /api/v1/ai-agents/{agent_id}: retrieve bot configuration
- PUT /api/v1/ai-agents/{agent_id}: modify bot configuration
LIMITS AND BEST PRACTICES
The API is subject to rate limits to guarantee service stability:
- 200 requests per minute per tenant on call and knowledge base endpoints
- 100 requests per minute (per IP address) on configuration endpoints (ai-agents, workspace)
- 10 document uploads per minute
- Excess requests receive a 429 (Too Many Requests) response
Frequently asked questions
ARE THERE SDKS IN DIFFERENT LANGUAGES?
We do not yet provide an official SDK. The API's OpenAPI schema allows you to generate a client in the language of your choice (Python, JavaScript, etc.) with standard tools.
IS THE API VERSIONED?
Yes, the API is versioned (currently v1). Major changes will be introduced in new versions, and previous versions will remain supported for at least 6 months.
Tip: the API is versioned (v1) and scoped per venue — always include your venue identifier (tenant_id) in the request path.