Agents

Manage standard 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

pageinteger · min: 1OptionalDefault: 1

limitinteger · min: 1 · max: 100OptionalDefault: 50

statusstring · enumOptionalPossible values:

searchstringOptional

Responses

200

List of agents

application/json

get

/agents

HTTPcURLJavaScriptPython

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

200

List of agents

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "type": "standard",
      "workspaceId": "text",
      "createdAt": "2025-12-13T09:32:14.528Z",
      "updatedAt": "2025-12-13T09:32:14.528Z",
      "standardConfig": {
        "languageId": "text",
        "voiceId": "text",
        "greeting": "text",
        "basePrompt": "text",
        "context": "text",
        "questions": "text",
        "customInstructions": "text",
        "recordingEnabled": true,
        "language": {
          "id": "text",
          "code": "text",
          "name": "text",
          "isActive": true
        },
        "voice": {
          "id": "text",
          "name": "text",
          "description": "text",
          "previewUrl": "text",
          "languageCode": "text"
        }
      },
      "knowledgeBases": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "sourceCount": 1,
          "agentCount": 1,
          "createdAt": "2025-12-13T09:32:14.528Z",
          "updatedAt": "2025-12-13T09:32:14.528Z"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "hasMore": true
  }
}

Create a new agent

post

Create a new voice agent.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Body

application/json

namestringRequired

Agent name

descriptionstringOptional

Agent description

workspaceIdstringOptional

Workspace ID (optional, uses default if not provided)

statusstring · enumOptionalDefault: ACTIVEPossible values:

Responses

201

Agent created successfully

application/json

post

/agents

HTTPcURLJavaScriptPython

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

{
  "name": "Customer Support Bot",
  "description": "Handles customer inquiries",
  "config": {
    "languageId": "lang_en_us",
    "voiceId": "voice_sarah",
    "greeting": "Hello! How can I help you today?",
    "basePrompt": "You are a helpful customer support agent...",
    "recordingEnabled": true,
    "greetingMessage": "Welcome! I'm your AI assistant.",
    "temperature": 0.7,
    "maxTokens": 1000
  }
}

201

Agent created successfully

{
  "id": "text",
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "type": "standard",
  "workspaceId": "text",
  "createdAt": "2025-12-13T09:32:14.528Z",
  "updatedAt": "2025-12-13T09:32:14.528Z",
  "standardConfig": {
    "languageId": "text",
    "voiceId": "text",
    "greeting": "text",
    "basePrompt": "text",
    "context": "text",
    "questions": "text",
    "customInstructions": "text",
    "recordingEnabled": true,
    "language": {
      "id": "text",
      "code": "text",
      "name": "text",
      "isActive": true
    },
    "voice": {
      "id": "text",
      "name": "text",
      "description": "text",
      "previewUrl": "text",
      "languageCode": "text"
    }
  },
  "knowledgeBases": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "sourceCount": 1,
      "agentCount": 1,
      "createdAt": "2025-12-13T09:32:14.528Z",
      "updatedAt": "2025-12-13T09:32:14.528Z"
    }
  ]
}

Get agent by ID

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Responses

200

Agent details

application/json

get

/agents/{id}

HTTPcURLJavaScriptPython

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

200

Agent details

{
  "id": "text",
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "type": "standard",
  "workspaceId": "text",
  "createdAt": "2025-12-13T09:32:14.528Z",
  "updatedAt": "2025-12-13T09:32:14.528Z",
  "standardConfig": {
    "languageId": "text",
    "voiceId": "text",
    "greeting": "text",
    "basePrompt": "text",
    "context": "text",
    "questions": "text",
    "customInstructions": "text",
    "recordingEnabled": true,
    "language": {
      "id": "text",
      "code": "text",
      "name": "text",
      "isActive": true
    },
    "voice": {
      "id": "text",
      "name": "text",
      "description": "text",
      "previewUrl": "text",
      "languageCode": "text"
    }
  },
  "knowledgeBases": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "sourceCount": 1,
      "agentCount": 1,
      "createdAt": "2025-12-13T09:32:14.528Z",
      "updatedAt": "2025-12-13T09:32:14.528Z"
    }
  ]
}

Update an agent

put

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Body

application/json

namestringOptional

descriptionstringOptional

statusstring · enumOptionalPossible values:

Responses

200

Agent updated successfully

application/json

put

/agents/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "config": {
    "languageId": "text",
    "voiceId": "text",
    "greeting": "text",
    "basePrompt": "text",
    "context": "text",
    "questions": "text",
    "customInstructions": "text",
    "recordingEnabled": true
  }
}

200

Agent updated successfully

{
  "id": "text",
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "type": "standard",
  "workspaceId": "text",
  "createdAt": "2025-12-13T09:32:14.528Z",
  "updatedAt": "2025-12-13T09:32:14.528Z",
  "standardConfig": {
    "languageId": "text",
    "voiceId": "text",
    "greeting": "text",
    "basePrompt": "text",
    "context": "text",
    "questions": "text",
    "customInstructions": "text",
    "recordingEnabled": true,
    "language": {
      "id": "text",
      "code": "text",
      "name": "text",
      "isActive": true
    },
    "voice": {
      "id": "text",
      "name": "text",
      "description": "text",
      "previewUrl": "text",
      "languageCode": "text"
    }
  },
  "knowledgeBases": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "sourceCount": 1,
      "agentCount": 1,
      "createdAt": "2025-12-13T09:32:14.528Z",
      "updatedAt": "2025-12-13T09:32:14.528Z"
    }
  ]
}

Delete an agent

delete

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Responses

204

Agent deleted successfully

delete

/agents/{id}

HTTPcURLJavaScriptPython

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

204

Agent deleted successfully

No content

Validate agent configuration

post

Validate agent configuration before creation

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Body

application/json

namestringRequired

Agent name

descriptionstringOptional

Agent description

workspaceIdstringOptional

Workspace ID (optional, uses default if not provided)

statusstring · enumOptionalDefault: ACTIVEPossible values:

Responses

200

Validation result

application/json

post

/agents/validate

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "text",
  "workspaceId": "text",
  "status": "ACTIVE",
  "config": {
    "languageId": "text",
    "voiceId": "text",
    "greeting": "text",
    "basePrompt": "text",
    "context": "text",
    "questions": "text",
    "customInstructions": "text",
    "recordingEnabled": true
  },
  "functions": [
    {
      "type": "TRANSFER",
      "name": "text",
      "description": "text",
      "config": {}
    }
  ]
}

200

Validation result

{
  "valid": true,
  "type": "standard",
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ],
  "warnings": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}