Get available regions
curl --request GET \
--url https://api.inya.ai/platform/v1/agents/config/regions \
--header 'x-api-key: <api-key>'import requests
url = "https://api.inya.ai/platform/v1/agents/config/regions"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)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>"
}Agent Config API
Get Regions
Retrieve the list of available deployment regions for agent hosting
GET
/
v1
/
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>'import requests
url = "https://api.inya.ai/platform/v1/agents/config/regions"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)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>"
}What it does: Retrieve all available deployment regions where 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.
See Error Reference for other status codes.
Required Permission
agents
Minimum working example
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. |
Errors
401 Unauthorized - Invalid or missing API key{
"status": "failure",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"message": "Invalid API key"
}
Use Cases
- Populating a region selector in a new agent creation flow
- Retrieving the
regIdneeded 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 Gnani support to trace a specific request.Was this page helpful?