API reference
Every public endpoint, generated from the CallMitra OpenAPI spec, with all responses and examples.
Every page below is generated from the same OpenAPI document the API is built from, so parameters, request bodies and responses always match production. Each endpoint lists every status code it can return, with an example body, and code samples in several languages.
| Base URL | https://api.callmitra.ai (paths include /api/v1) |
| Authentication | X-API-Key: vk_live_… (details) |
| Format | JSON request and response bodies, camelCase fields, ISO 8601 UTC timestamps, UUID IDs |
| Errors | detail plus a structured error object (catalogue) |
| Limits | 300 requests per minute per key (rate limits) |
| OpenAPI | Download openapi.json for Postman, Bruno, Insomnia or code generators |
Agents
Calls
Campaigns
- Create an empty campaign POST
- Create a campaign with its leads POST
- Delete a campaign DELETE
- Get a campaign GET
- Dialing status GET
- List scheduled callbacks GET
- List a campaign's leads GET
- List campaigns GET
- Pause automatic dialing POST
- Resume automatic dialing POST
- Start a campaign POST
- Stop a campaign POST
- Update a campaign PUT
- Add or remove leads PUT
Do not call
Lead intake webhook
Lead notes
Leads
Phone numbers
Tickets
Webhooks
- Create a webhook endpoint POST
- Delete a webhook endpoint DELETE
- Get a webhook delivery GET
- Get a webhook endpoint GET
- List webhook deliveries GET
- List webhook endpoints GET
- List event types GET
- callback.completed: a booked callback was made Webhook
- callback.failed: a booked callback did not reach the lead Webhook
- callback.scheduled: a callback was booked Webhook
- call.completed: a call finished Webhook
- call.escalated: a call was transferred to a person Webhook
- call.failed: a call ended without connecting Webhook
- campaign.completed: a campaign dialled every lead Webhook
- campaign.started: a campaign was started Webhook
- lead.created: a lead was created Webhook
- lead.updated: a lead was edited Webhook
- ticket.created: a support ticket was opened Webhook
- ticket.rated: a customer rated a support ticket Webhook
- ticket.reopened: a support ticket opened again Webhook
- ticket.resolved: a support ticket was resolved Webhook
- ticket.updated: a support ticket changed Webhook
- transfer.failed: a transfer to a person did not connect Webhook
- webhook.test: sent by the send test event operation Webhook
- whatsapp.message.received: a customer sent a WhatsApp message Webhook
- Redeliver an event POST
- Rotate an endpoint's signing secret POST
- Send a test event POST
- Set an agent's post-call webhook PUT
- Update a webhook endpoint PATCH
Workspace
Import agents
Bring an agent from Vapi, Retell, Bland or another CallMitra workspace into CallMitra with one API call.
Create an agent POST
Creates an agent from a `config` (see the AgentConfig schema). It starts as a `draft`; publish it with publishAgent, or send `status: published`. Values outside the documented range or list, and a language, voice or model that is not available, are refused with `parameter_invalid` naming the field (for example `config.voice`).