OpenAPI reference
Chatevo publishes a machine-readable OpenAPI 3.1 specification and an interactive explorer for every public endpoint.
Interactive docs
Section titled “Interactive docs”| Resource | URL |
|---|---|
| Swagger UI | https://api.chatevo.ai/api/docs |
| OpenAPI JSON | https://api.chatevo.ai/api/docs/openapi.json |
| OpenAPI YAML | https://api.chatevo.ai/api/docs/openapi.yaml |
Open the Swagger UI in a browser to browse endpoints, inspect schemas, and send authenticated try-it-out requests.
Authentication in Swagger UI
Section titled “Authentication in Swagger UI”- Click Authorize.
- Enter your API key as
Bearer ch_live_xxx(or paste the key — the UI adds the prefix). - Execute requests against your organization data.
Session cookie auth works when you are logged into the dashboard in the same browser.
What the spec covers
Section titled “What the spec covers”| Tag | Endpoints |
|---|---|
assistants | CRUD, attach KBs and tools |
knowledge-bases | CRUD, documents, reindex |
tools | CRUD, test invocation |
conversations | List, create, close |
messages | Direct API send and list |
widget | Config and messages (public) |
webhooks | Endpoint registration |
Code generation
Section titled “Code generation”Use the OpenAPI JSON URL with your preferred generator:
# Example: TypeScript fetch clientnpx openapi-typescript https://api.chatevo.ai/api/docs/openapi.json -o ./src/chatevo-api.tsGenerated clients should still respect rate limits and idempotency headers.
Versioning
Section titled “Versioning”The info.version field in the spec matches the API version prefix (v1). Subscribe to the Chatevo changelog for breaking change notices.