List Agents

List all agents

curl --request GET \
  --url https://api.inya.ai/platform/v1/agents \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

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": "Agents retrieved successfully",
  "response": {
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 1,
    "totalPages": 1,
    "bots": [
      {
        "botId": "fb79920229d144608ebf665a10e50275",
        "botName": "Support Agent",
        "botInfo": {
          "botDescription": "Handles inbound customer support calls.",
          "botLanguage": [
            "en-IN"
          ],
          "botRegion": "asia",
          "botTimezone": "Asia/Kolkata"
        },
        "createdAt": "2026-04-01T10:00:00Z",
        "updatedAt": "2026-07-01T12:00:00Z"
      }
    ]
  }
}

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

GET

agents

List all agents

curl --request GET \
  --url https://api.inya.ai/platform/v1/agents \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

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": "Agents retrieved successfully",
  "response": {
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 1,
    "totalPages": 1,
    "bots": [
      {
        "botId": "fb79920229d144608ebf665a10e50275",
        "botName": "Support Agent",
        "botInfo": {
          "botDescription": "Handles inbound customer support calls.",
          "botLanguage": [
            "en-IN"
          ],
          "botRegion": "asia",
          "botTimezone": "Asia/Kolkata"
        },
        "createdAt": "2026-04-01T10:00:00Z",
        "updatedAt": "2026-07-01T12:00:00Z"
      }
    ]
  }
}

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

Overview

Retrieve a paginated list of all voice agents belonging to your organization. Results can be filtered by agent name and paginated for easy navigation through large collections.

Required Permission

agents

Query Parameters

Name	Type	Required	Description
`search`	string	No	Filter results by agent name (partial match).
`pageNo`	integer	No	Page number to retrieve. Default: `1`. Must be `1` or greater — sending `pageNo=0` returns HTTP 500.
`pageSize`	integer	No	Number of agents per page. Default: `10`.

Example cURL

curl "https://api.inya.ai/platform/v1/agents?search=support&pageNo=1&pageSize=10" \
  -H "x-api-key: <your_api_key>"

Response

Success (200)

{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Agents retrieved successfully",
  "response": {
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 1,
    "totalPages": 1,
    "bots": [
      {
        "botId": "fb79920229d144608ebf665a10e50275",
        "botName": "Support Agent",
        "botInfo": {
          "botDescription": "Handles inbound customer support calls.",
          "botLanguage": ["en-IN"],
          "botRegion": "asia",
          "botTimezone": "Asia/Kolkata"
        },
        "createdAt": "2026-04-01T10:00:00Z",
        "updatedAt": "2026-07-01T12:00:00Z"
      }
    ]
  }
}

Response Fields

Field	Type	Description
`pageNo`	integer	Current page number.
`pageSize`	integer	Number of results per page.
`totalCount`	integer	Total number of agents in your organization.
`totalPages`	integer	Total number of pages available.
`bots[].botId`	string	Unique agent identifier.
`bots[].botName`	string	Agent display name.
`bots[].botInfo`	object	Summary object containing `botDescription`, `botLanguage`, `botRegion`, and `botTimezone`.
`bots[].createdAt`	string	ISO 8601 timestamp of when the agent was created.
`bots[].updatedAt`	string	ISO 8601 timestamp of the most recent update.

Use Cases

Viewing all agents in your organization
Searching for a specific agent by name before retrieving its full configuration
Building an agent management dashboard with pagination

Use the search parameter to quickly locate a specific agent by name instead of paginating through all results.

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

Query Parameters

string

Filter results by agent name (partial match)

pageNo

integer

default:1

Page number to retrieve. Default 1.

Required range: x >= 1

pageSize

integer

default:10

Number of agents per page. Default 10.

Required range: 1 <= x <= 100

Response

Agents retrieved 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

Query Parameters

Example cURL

Response

Success (200)

Response Fields

Use Cases

Authorizations

Query Parameters

Response

​Overview

​Required Permission

​Query Parameters

​Example cURL

​Response

​Success (200)

​Response Fields

​Use Cases

Authorizations

Query Parameters

Response

Overview

Required Permission

Query Parameters

Example cURL

Response

Success (200)

Response Fields

Use Cases