API Reference
The IdentityCall API is organized around REST. Our API accepts JSON request bodies, returns JSON responses, and uses standard HTTP response codes.
Base URL
All API requests should be made to:
https://api.identitycall.com/api/v1/publicAuthentication
The API uses Bearer token authentication. Include your API key in the Authorization header:
Authorization: Bearer idc_your_api_keySee Authentication for details on creating and managing API keys.
Content Types
All requests that include a body should use:
multipart/form-datafor file uploadsapplication/jsonfor JSON data
All responses are returned as application/json.
Endpoints
Recordings
| Endpoint | Method | Description |
|---|---|---|
/recordings | GET | List all recordings |
/recordings | POST | Upload a new recording |
/recordings/:id | GET | Get recording details |
/recordings/:id | PATCH | Update recording metadata |
/recordings/:id | DELETE | Delete a recording |
/recordings/:id/transcription | GET | Get transcription |
/recordings/:id/results | GET | Get analysis results |
/recordings/:id/summary | GET | Get call summary |
Pagination
List endpoints return paginated results. Use these query parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
page | integer | 1 | Page number |
per_page | integer | 20 | Items per page (max 100) |
Response format:
{
"data": [...],
"meta": {
"current_page": 1,
"total_pages": 5,
"total_count": 100,
"per_page": 20
}
}Rate Limiting
API requests are rate limited based on your plan:
| Plan | Requests/minute |
|---|---|
| Free | 60 |
| Pro | 300 |
| Enterprise | Custom |
When rate limited, you’ll receive a 429 Too Many Requests response with a Retry-After header.
Error Handling
The API uses standard HTTP status codes:
| Code | Description |
|---|---|
| 200 | Success |
| 201 | Created |
| 204 | No Content (successful delete) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 422 | Unprocessable Entity |
| 429 | Too Many Requests |
| 500 | Internal Server Error |
Error responses include a message:
{
"error": "Description of what went wrong"
}See Errors for detailed error handling guidance.