List agents

Retrieve a list of all agents for the authenticated user

GET /agents

List agents

cURL

curl --request GET \
  --url https://api.omnia-voice.com/api/v1/agents \
  --header 'X-API-Key: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "status": "ACTIVE",
      "type": "standard",
      "workspaceId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "standardConfig": {
        "languageId": "<string>",
        "voiceId": "<string>",
        "basePrompt": "<string>",
        "greeting": "<string>",
        "context": "<string>",
        "questions": "<string>",
        "customInstructions": "<string>",
        "recordingEnabled": true,
        "temperature": 0,
        "maxDuration": 3000,
        "firstSpeaker": "agent",
        "interruptible": false,
        "inactivityTimeout": 155,
        "inactivityAction": "hang_up",
        "model": "llama",
        "language": {
          "id": "<string>",
          "code": "<string>",
          "name": "<string>",
          "isActive": true
        },
        "voice": {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "previewUrl": "<string>",
          "languageCode": "<string>",
          "gender": "<string>",
          "isActive": true,
          "language": {
            "code": "<string>",
            "name": "<string>"
          }
        }
      },
      "actions": [
        {}
      ],
      "knowledgeBases": [
        {}
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  }
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Query Parameters

page · integer · default: 1

Page number

limit · integer · default: 50

Items per page

Required range: x <= 100

status · enum<string>

Filter by status

Available options: ACTIVE, INACTIVE, SUSPENDED

search · string

Case-insensitive match against agent name and description

Response

200

application/json

Successful response

data · object[]

Show child attributes

pagination · object

Show child attributes