Skip to main content
What it does: Gives you programmatic control over agents you build in Agent Builder — create and update configuration, manage FAQs, read conversation logs, and configure the embeddable chat widget. For speech processing in your own stack, use Gnani Speech APIs instead.

​
Base URL

All paths below are relative to this URL. Requests must use HTTPS.

​
Authentication

Include your API key on every request:
Keys are scoped by permission: Invalid keys return 401. Valid keys without the required permission return 403.
Save the requestId from each response. You will need it when contacting support.

​
Response format

Successful responses use this envelope:
Paginated lists also include pageNo, pageSize, totalCount, and totalPages inside response.

​
API groups

​
Typical integration flows

​
Build and deploy an agent

  1. Get Languages and Get Transcriber Config
  2. Create Agent — get a botId
  3. Update Agent — set prompt, voice, and integrations
  4. Trigger Call — test in development
  5. Get Conversation Logs → Get Conversation Statistics

​
Review calls after they happen

Option A — Poll (good for backfills and ad-hoc review)
  1. Get Conversation Logs — list calls; copy conversationId
  2. Get Conversation Statistics — read overallCallDisposition and utteranceAnalytics
  3. Get Conversation Audio — download MP3 (optional)
Option B — Webhook (good for real-time CRM integrations)
  1. Update Agent — set hasPostCallTrigger: true and your URL
  2. Trigger Call — place the call
  3. Your server receives the post-call payload automatically when the call ends

​
Understanding call outcome fields

When you read call data — from Stats, Logs, or a webhook — you will see several outcome fields. Here is what each one means: See Get Conversation Statistics for a full breakdown with examples.

​
Quick start

Create an agent with one request:
Example response:
Use the returned botId to configure the agent, attach FAQs, and trigger calls.

​
Try the API in Postman

Prefer Postman to curl? Download the collection below — every Platform API endpoint in one place, with headers and sample bodies ready to go. Import it, add your API key, and start sending requests. Download the Postman collection (43 KB) Right-click the link and choose Save link as… if your browser opens the JSON instead of downloading.

​
Import into Postman

Once you have the file:
  1. Open Postman
  2. Click Import → Upload Files → select the downloaded JSON
  3. Use Find & Replace (Cmd+Shift+F / Ctrl+Shift+H) on the collection to replace placeholders: YOUR_PLATFORM_API_KEY, YOUR_BOT_ID, YOUR_CONVERSATION_ID, YOUR_FAQ_ID
  4. Open any request and click Send — no separate environment file is required

​
Concepts

System prompts — Use Jinja2 variables such as {{ customer_name }}. Validate syntax with Validate Prompt before saving. Multi-language agents — Up to three languages per agent. Call Get Transcriber Config and Get TTS Config before Update Agent. Pre-call variables — Inject caller-specific fields into the prompt at call time. FAQ knowledge base — Up to 100 Q&A pairs per agent; matched before the LLM generates an answer. Outbound calls — Use Trigger Call with clientReferenceId to link calls to your CRM. Post-call automation — Set hasPostCallTrigger: true via Update Agent to push call outcomes to your server. Use polling (Logs → Stats) when you need historical data instead.

​
HTTP status codes

​
Best practices

  • Call the Config API before creating or updating agents so ASR and TTS choices support every configured language.
  • Validate prompts before saving.
  • Test in development first; pass ?environment=development when required.
  • Log every requestId for support escalations.
  • Keep API keys out of source control.

​
Next steps

​
Docs feedback

Docs feedback: Agent Builder Platform docs feedback Last verified: 11 August 2026