> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gnani.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Regions

> Retrieve the list of available deployment regions for agent hosting

## 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

```bash theme={null}
curl "https://api.inya.ai/platform/v1/agents/config/regions" \
  -H "x-api-key: <your_api_key>"
```

## Response

### Success (200)

```json theme={null}
{
  "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

<Tip>
  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`.
</Tip>

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


## OpenAPI

````yaml GET /v1/agents/config/regions
openapi: 3.0.3
info:
  title: Platform Agent Config API
  description: >-
    Read-only endpoints for discovering valid configuration values — languages,
    regions, timezones, LLM models, ASR providers, and TTS voices — before
    creating or updating agents.
  version: 2.1.0
servers:
  - url: https://api.inya.ai/platform
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: AgentConfiguration
    description: Agent configuration discovery operations
paths:
  /v1/agents/config/regions:
    get:
      tags:
        - AgentConfiguration
      summary: Get available regions
      description: Retrieve all available deployment regions.
      operationId: getRegions
      responses:
        '200':
          description: Region data retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
              examples:
                success:
                  value:
                    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
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    StandardResponse:
      type: object
      properties:
        status:
          type: string
          example: success
        requestId:
          type: string
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        message:
          type: string
        response:
          type: object
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          example: failure
        requestId:
          type: string
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        message:
          type: string
  responses:
    ServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key with 'agents' permission

````