Create Agent

Create a new agent

curl --request POST \
  --url https://api.inya.ai/platform/v1/agents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "botName": "Support Agent"
}
'

import requests

url = "https://api.inya.ai/platform/v1/agents"

payload = { "botName": "Support Agent" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({botName: 'Support Agent'})
};

fetch('https://api.inya.ai/platform/v1/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "An agent named 'Support Agent' already exists in your organization"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

POST

agents

Create a new agent

curl --request POST \
  --url https://api.inya.ai/platform/v1/agents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "botName": "Support Agent"
}
'

import requests

url = "https://api.inya.ai/platform/v1/agents"

payload = { "botName": "Support Agent" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({botName: 'Support Agent'})
};

fetch('https://api.inya.ai/platform/v1/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "An agent named 'Support Agent' already exists in your organization"
}

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

Overview

Create a new voice agent within your organization. The agent is initialized with sensible defaults that match the configuration applied when creating an agent through the Inya dashboard. You can then update any setting via the Update Agent endpoint.

Required Permission

agents

Request Body

Field	Type	Required	Default	Description
`botName`	string	Yes	—	Unique agent name within your organization.
`description`	string	No	`""`	A brief description of the agent’s purpose.
`region`	string	No	`"asia"`	Deployment region. Valid values: `asia`, `america`, `europe`. See Get Regions.
`timeZone`	string	No	`"Asia/Kolkata"`	IANA timezone string. See Get Timezones for valid values.

Default Configuration

The created agent inherits the following default configuration: barge-in enabled, TTS caching enabled, LLM temperature 0.5, max tokens 300, and language derived from the selected region.

Example cURL

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"
  }'

Response

Success (201)

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

Error Responses

403 Forbidden - Insufficient permissions (QA role)

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "QA role does not have permission to create/update agents"
}

409 Conflict - Agent name already exists

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "An agent named 'Support Agent' already exists in your organization"
}

Use Cases

Setting up a new customer support agent
Creating region-specific agents for different markets
Deploying separate agents for different departments or products

Use the Get Regions, Get Timezones, and Get Languages config endpoints to discover valid values for region and timeZone before creating an agent.

Save the requestId from every response. You will need it if you contact Inya support to trace a specific request.

Authorizations

x-api-key

string

header

required

API key with 'agents' permission

Body

application/json

botName

string

required

Example:

"Support Agent"

description

string

Example:

"Handles inbound customer support calls."

region

enum<string>

default:asia

Available options:

asia,

america,

europe

Example:

"asia"

timeZone

string

default:Asia/Kolkata

Example:

"Asia/Kolkata"

Response

Agent created successfully

status

string

Example:

"success"

requestId

string

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

message

string

response

object

Getting Started

Agents API

Conversations API

Agent Config API

Agent FAQ API

Chat SDK API

Reference

Overview

Required Permission

Request Body

Default Configuration

Example cURL

Response

Success (201)

Error Responses

Use Cases

Authorizations

Body

Response

​Overview

​Required Permission

​Request Body

​Default Configuration

​Example cURL

​Response

​Success (201)

​Error Responses

​Use Cases

Authorizations

Body

Response

Overview

Required Permission

Request Body

Default Configuration

Example cURL

Response

Success (201)

Error Responses

Use Cases