Introduction – Agent Builder Platform API

The Agent Builder Platform API gives you programmatic control over agents you build in Inya 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

https://api.inya.ai/platform

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

Authentication

Include your API key on every request:

x-api-key: <your_api_key>

Keys are scoped by permission:

Permission	Endpoints
`agents`	`/v1/agents/*`
`conversations`	`/v1/conversations/*`

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:

{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Human-readable description.",
  "response": {}
}

Paginated lists also include pageNo, pageSize, totalCount, and totalPages inside response.

API groups

Group	Path	Guide
Agents	`/v1/agents`	Create Agent
Agent config	`/v1/agents/config`	Get Languages
Agent FAQ	`/v1/agents/{botId}/faqs`	Add FAQs
Conversations	`/v1/conversations`	Get Conversation Logs
Chat SDK	`/v1/agents/{botId}/chat-sdk-config`	Get Chat SDK Config

Quick start

Create an agent with one request:

curl -X POST "https://api.inya.ai/platform/v1/agents" \
  -H "x-api-key: <your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "botName": "Support Agent",
    "description": "Handles inbound customer support calls.",
    "region": "asia",
    "timeZone": "Asia/Kolkata"
  }'

Example response:

{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Agent created successfully.",
  "response": {
    "botId": "fb79920229d144608ebf665a10e50275",
    "botName": "Support Agent"
  }
}

Use the returned botId to configure the agent, attach FAQs, and trigger calls.

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.

HTTP status codes

Code	Meaning
200	Success
201	Created
400	Invalid request
401	Authentication failed
403	Permission denied or inaccessible `botId`
404	Resource not found
409	Conflict (e.g. duplicate agent name)
429	Rate limit exceeded
500	Server error

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: 5 August 2026

Getting Started

Agents API

Conversations API

Agent Config API

Agent FAQ API

Chat SDK API

Reference

Introduction – Agent Builder Platform API

Base URL

Authentication

Response format

API groups

Quick start

Concepts

HTTP status codes

Best practices

Next steps

Docs feedback

​Base URL

​Authentication

​Response format

​API groups

​Quick start

​Concepts

​HTTP status codes

​Best practices

​Next steps

​Docs feedback

Base URL

Authentication

Response format

API groups

Quick start

Concepts

HTTP status codes

Best practices

Next steps

Docs feedback