Centerfy AI API Reference
Programmatically manage AI agents with the Centerfy REST API. Create, update, retrieve, and delete agents from your own applications and workflows.
The Centerfy AI API lets you manage AI agents programmatically — create agents, update configurations, retrieve details, archive agents, make outbound AI calls, fetch recordings, and send messages across channels. All endpoints are RESTful and accept JSON.
Base URL
https://crmwebhook.com/functions/v1/crm-api
Authentication
Every request must include your API key. You can pass it as either:
- Bearer token in the
Authorizationheader - API key in the
x-api-keyheader
# Option 1: Bearer token
curl -H "Authorization: Bearer cfy_your_api_key_here" \
https://crmwebhook.com/functions/v1/crm-api/get-agent/{agentId}
# Option 2: x-api-key header
curl -H "x-api-key: cfy_your_api_key_here" \
https://crmwebhook.com/functions/v1/crm-api/get-agent/{agentId}
Available Endpoints
Retrieve the full configuration of a specific AI agent by ID.
Create a new AI agent with voice, language, and behavior settings.
Modify an existing agent’s configuration — name, voice, model, or any setting.
Archive an agent so it stops handling calls. Can be restored later.
Trigger an outbound AI voice call to a contact using a specified agent.
Get a pre-signed playback URL for a call recording.
Retrieve a contact’s conversation history with pagination.
Send a message via SMS, email, WhatsApp, Facebook, or Instagram.
Rate Limits
The API is rate-limited to 60 requests per minute per API key. If you exceed this, you’ll receive a 429 Too Many Requests response. Back off and retry after a few seconds.
Error Responses
All errors return a JSON object with a message field:
{
"error": true,
"message": "Invalid API key"
}
| Status Code | Meaning |
|---|---|
200 / 201 | Success |
400 | Bad request — check your request body |
401 | Unauthorized — invalid or missing API key |
403 | Forbidden — organization/sub-account mismatch with API key scope |
404 | Resource not found |
429 | Rate limit exceeded |
500 | Server error — retry or contact support |
502 | Upstream service unavailable |