Get Regions

Get available regions

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

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

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

{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Region data retrieved successfully",
  "response": {
    "regions": [
      {
        "regId": "asia",
        "name": "Asia"
      },
      {
        "regId": "america",
        "name": "United States"
      },
      {
        "regId": "europe",
        "name": "Europe"
      }
    ]
  }
}

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

GET

agents

config

regions

Get available regions

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

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

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

{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Region data retrieved successfully",
  "response": {
    "regions": [
      {
        "regId": "asia",
        "name": "Asia"
      },
      {
        "regId": "america",
        "name": "United States"
      },
      {
        "regId": "europe",
        "name": "Europe"
      }
    ]
  }
}

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

Overview

Retrieve all available deployment regions where Inya agents can be hosted. Each region represents a geographic cluster with dedicated infrastructure optimized for low-latency voice interactions. The region you choose when creating an agent determines where audio processing and AI inference run.

Required Permission

agents

Example cURL

curl "https://api.inya.ai/platform/v1/agents/config/regions" \
  -H "x-api-key: <your_api_key>"

Response

Success (200)

{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Region data retrieved successfully",
  "response": {
    "regions": [
      { "regId": "asia", "name": "Asia" },
      { "regId": "america", "name": "Americas" },
      { "regId": "europe", "name": "Europe" }
    ]
  }
}

Response Fields

Field	Type	Description
`regId`	string	Unique region identifier. Use this value as the `region` field in Create Agent and as the `regId` path parameter in Get Timezones.
`name`	string	Human-readable region display name.

Use Cases

Populating a region selector in a new agent creation flow
Retrieving the regId needed to call Get Timezones for timezone selection
Presenting region options in a configuration dashboard

The regId returned here is used directly as the region field in Create Agent and as the {regId} path parameter in Get Timezones. For example: asia, america, or europe.

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

Response

Region data 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

Example cURL

Response

Success (200)

Response Fields

Use Cases

Authorizations

Response

​Overview

​Required Permission

​Example cURL

​Response

​Success (200)

​Response Fields

​Use Cases

Authorizations

Response

Overview

Required Permission

Example cURL

Response

Success (200)

Response Fields

Use Cases