Agents

Manage voice agents

List agents

get

Retrieve a list of all agents for the authenticated user

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Query parameters

pageintegerOptional

Page number

Default: 1

limitinteger · max: 100Optional

Items per page

Default: 50

statusstring · enumOptional

Filter by status

Possible values:

Responses

200

Successful response

application/json

401

Unauthorized

application/json

get

/agents

HTTPcURLJavaScriptPython

GET /api/v1/agents HTTP/1.1
Host: dashboard.omnia-voice.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "createdAt": "2026-02-08T10:10:50.955Z",
      "updatedAt": "2026-02-08T10:10:50.955Z",
      "config": {
        "languageId": "text",
        "voiceId": "text",
        "greeting": "text",
        "basePrompt": "text",
        "context": "text",
        "questions": "text",
        "customInstructions": "text",
        "recordingEnabled": true,
        "temperature": 1,
        "maxDuration": 1,
        "firstSpeaker": "agent",
        "interruptible": true,
        "inactivityTimeout": 1,
        "inactivityAction": "hang_up",
        "language": {
          "id": "text",
          "code": "text",
          "name": "text",
          "isActive": true
        },
        "voice": {
          "id": "text",
          "name": "text",
          "description": "text",
          "previewUrl": "text",
          "languageCode": "text"
        }
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1
  }
}

Create agent

post

Create a new agent

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Body

application/json

namestringRequired

Agent name

descriptionstringOptional

Agent description

statusstring · enumOptionalDefault: ACTIVEPossible values:

Responses

201

Agent created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

post

/agents

HTTPcURLJavaScriptPython

POST /api/v1/agents HTTP/1.1
Host: dashboard.omnia-voice.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 359

{
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "config": {
    "languageId": "text",
    "voiceId": "text",
    "greeting": "text",
    "basePrompt": "text",
    "context": "text",
    "questions": "text",
    "customInstructions": "text",
    "recordingEnabled": true,
    "temperature": 0,
    "maxDuration": 3000,
    "firstSpeaker": "agent",
    "interruptible": false,
    "inactivityTimeout": 1,
    "inactivityAction": "hang_up"
  }
}

{
  "id": "text",
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "createdAt": "2026-02-08T10:10:50.955Z",
  "updatedAt": "2026-02-08T10:10:50.955Z",
  "config": {
    "languageId": "text",
    "voiceId": "text",
    "greeting": "text",
    "basePrompt": "text",
    "context": "text",
    "questions": "text",
    "customInstructions": "text",
    "recordingEnabled": true,
    "temperature": 1,
    "maxDuration": 1,
    "firstSpeaker": "agent",
    "interruptible": true,
    "inactivityTimeout": 1,
    "inactivityAction": "hang_up",
    "language": {
      "id": "text",
      "code": "text",
      "name": "text",
      "isActive": true
    },
    "voice": {
      "id": "text",
      "name": "text",
      "description": "text",
      "previewUrl": "text",
      "languageCode": "text"
    }
  }
}

Get agent

get

Retrieve a specific agent by ID

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Agent ID

Responses

200

Successful response

application/json

404

Agent not found

application/json

get

/agents/{id}

HTTPcURLJavaScriptPython

GET /api/v1/agents/{id} HTTP/1.1
Host: dashboard.omnia-voice.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "createdAt": "2026-02-08T10:10:50.955Z",
  "updatedAt": "2026-02-08T10:10:50.955Z",
  "config": {
    "languageId": "text",
    "voiceId": "text",
    "greeting": "text",
    "basePrompt": "text",
    "context": "text",
    "questions": "text",
    "customInstructions": "text",
    "recordingEnabled": true,
    "temperature": 1,
    "maxDuration": 1,
    "firstSpeaker": "agent",
    "interruptible": true,
    "inactivityTimeout": 1,
    "inactivityAction": "hang_up",
    "language": {
      "id": "text",
      "code": "text",
      "name": "text",
      "isActive": true
    },
    "voice": {
      "id": "text",
      "name": "text",
      "description": "text",
      "previewUrl": "text",
      "languageCode": "text"
    }
  }
}

Update agent

put

Update an existing agent

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Agent ID

Body

application/json

namestringOptional

descriptionstringOptional

statusstring · enumOptionalPossible values:

Responses

200

Agent updated successfully

application/json

404

Agent not found

application/json

put

/agents/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/agents/{id} HTTP/1.1
Host: dashboard.omnia-voice.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 355

{
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "config": {
    "languageId": "text",
    "voiceId": "text",
    "greeting": "text",
    "basePrompt": "text",
    "context": "text",
    "questions": "text",
    "customInstructions": "text",
    "recordingEnabled": true,
    "temperature": 1,
    "maxDuration": 1,
    "firstSpeaker": "agent",
    "interruptible": true,
    "inactivityTimeout": 1,
    "inactivityAction": "hang_up"
  }
}

{
  "id": "text",
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "createdAt": "2026-02-08T10:10:50.955Z",
  "updatedAt": "2026-02-08T10:10:50.955Z",
  "config": {
    "languageId": "text",
    "voiceId": "text",
    "greeting": "text",
    "basePrompt": "text",
    "context": "text",
    "questions": "text",
    "customInstructions": "text",
    "recordingEnabled": true,
    "temperature": 1,
    "maxDuration": 1,
    "firstSpeaker": "agent",
    "interruptible": true,
    "inactivityTimeout": 1,
    "inactivityAction": "hang_up",
    "language": {
      "id": "text",
      "code": "text",
      "name": "text",
      "isActive": true
    },
    "voice": {
      "id": "text",
      "name": "text",
      "description": "text",
      "previewUrl": "text",
      "languageCode": "text"
    }
  }
}

Delete agent

delete

Delete an agent

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Agent ID

Responses

200

Agent deleted successfully

application/json

404

Agent not found

application/json

delete

/agents/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/agents/{id} HTTP/1.1
Host: dashboard.omnia-voice.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "text"
}