Voice Agent Consumer API

The Consumer API exposes your Voice Agent tenant's data to external systems — agents, call logs, tools, and tool-call execution logs — over a simple REST surface.

Base URL

All endpoints are served under the /api/v1.0 prefix of your main domain:

/api/v1.0

Every request must include an API key:

Authorization: Bearer <CONSUMER_API_KEY>

Envelope

All responses use a consistent envelope.

List endpoints return:

{ "data": [ /* Dtos */ ], "meta": { "total": 0, "offset": 0, "limit": 20 } }

Single-resource endpoints return:

{ "data": { /* Dto */ } }

Errors return:

{ "statusCode": 0, "errorCode": "string", "message": "string", "eventId": "string", "timestamp": "string", "path": "string" }

Common query params

List endpoints accept these common params:

Param	Type	Default	Description
offset	int	0	Number of items to skip (min 0).
limit	int	20	Max items to return (max 100; 400 be-consumer-invalid-limit if >100 or <0).

Quick start

curl -H "Authorization: Bearer $CONSUMER_API_KEY" \
  "/agents?offset=0&limit=20"

Sections

• Authentication
• Agents
• Calls
• Tools
• Tool Calls
• Knowledge Bases
• Errors
• Rate Limits