Tools

Manage agent tools and actions

List tools

get

Retrieve a list of all tools for the authenticated user

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Query parameters

pageintegerOptionalDefault: 1

limitintegerOptionalDefault: 50

typestring · enumOptionalPossible values:

Responses

200

Successful response

application/json

get

/agent-tools

HTTPcURLJavaScriptPython

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

200

Successful response

{
  "data": [
    {
      "id": "text",
      "type": "http",
      "name": "text",
      "modelToolName": "text",
      "description": "text",
      "baseUrlPattern": "text",
      "httpMethod": "GET",
      "dynamicParameters": {
        "ANY_ADDITIONAL_PROPERTY": {
          "location": "body",
          "schema": {
            "type": "string",
            "description": "text",
            "enum": [
              "text"
            ],
            "required": true
          },
          "required": true
        }
      },
      "automaticParameters": {
        "ANY_ADDITIONAL_PROPERTY": {
          "location": "body",
          "knownValue": "text"
        }
      },
      "staticParameters": {
        "ANY_ADDITIONAL_PROPERTY": {
          "location": "header",
          "value": "text"
        }
      },
      "createdAt": "2026-02-08T10:05:43.921Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1
  }
}

Create tool

post

Create a new tool

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Body

application/json

typestring · enumRequired

Tool type - 'http' for HTTP API tools, 'client' for client-side tools

Possible values:

namestringRequired

Tool display name

modelToolNamestringRequired

Name used by AI model (must be unique)

descriptionstringOptional

Tool description

baseUrlPatternstringOptional

API endpoint URL (required for http tools)

httpMethodstring · enumOptional

HTTP method (required for http tools)

Possible values:

Responses

201

Tool created successfully

application/json

400

Invalid request body

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

/agent-tools

HTTPcURLJavaScriptPython

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

{
  "name": "Forward Call",
  "description": "Transfers call to a human agent when needed",
  "modelToolName": "forwardCall",
  "httpMethod": "POST",
  "baseUrlPattern": "https://your-api.com/webhooks/forward-call",
  "automaticParameters": {
    "callId": {
      "location": "body",
      "knownValue": "KNOWN_PARAM_CALL_ID"
    }
  },
  "dynamicParameters": {
    "targetNumber": {
      "location": "body",
      "schema": {
        "type": "string",
        "description": "Phone number to forward to"
      },
      "required": true
    },
    "reason": {
      "location": "body",
      "schema": {
        "type": "string",
        "description": "Reason for transferring the call"
      },
      "required": true
    }
  }
}

Call Forwarding ToolAppointment Booking Tool

{
  "id": "text",
  "type": "http",
  "name": "text",
  "modelToolName": "text",
  "description": "text",
  "baseUrlPattern": "text",
  "httpMethod": "GET",
  "dynamicParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "location": "body",
      "schema": {
        "type": "string",
        "description": "text",
        "enum": [
          "text"
        ],
        "required": true
      },
      "required": true
    }
  },
  "automaticParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "location": "body",
      "knownValue": "text"
    }
  },
  "staticParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "location": "header",
      "value": "text"
    }
  },
  "createdAt": "2026-02-08T10:05:43.921Z"
}

Get tool

get

Retrieve a specific tool by ID

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Responses

200

Successful response

application/json

get

/agent-tools/{id}

HTTPcURLJavaScriptPython

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

200

Successful response

{
  "id": "text",
  "type": "http",
  "name": "text",
  "modelToolName": "text",
  "description": "text",
  "baseUrlPattern": "text",
  "httpMethod": "GET",
  "dynamicParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "location": "body",
      "schema": {
        "type": "string",
        "description": "text",
        "enum": [
          "text"
        ],
        "required": true
      },
      "required": true
    }
  },
  "automaticParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "location": "body",
      "knownValue": "text"
    }
  },
  "staticParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "location": "header",
      "value": "text"
    }
  },
  "createdAt": "2026-02-08T10:05:43.921Z"
}

Update tool

put

Update an existing tool

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Body

application/json

typestring · enumRequired

Tool type - 'http' for HTTP API tools, 'client' for client-side tools

Possible values:

namestringRequired

Tool display name

modelToolNamestringRequired

Name used by AI model (must be unique)

descriptionstringOptional

Tool description

baseUrlPatternstringOptional

API endpoint URL (required for http tools)

httpMethodstring · enumOptional

HTTP method (required for http tools)

Possible values:

Responses

200

Tool updated successfully

application/json

put

/agent-tools/{id}

HTTPcURLJavaScriptPython

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

{
  "type": "http",
  "name": "text",
  "modelToolName": "text",
  "description": "text",
  "baseUrlPattern": "text",
  "httpMethod": "GET",
  "dynamicParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "location": "body",
      "schema": {
        "type": "string",
        "description": "text",
        "enum": [
          "text"
        ]
      },
      "required": true
    }
  },
  "automaticParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "location": "body",
      "knownValue": "text"
    }
  },
  "staticParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "location": "header",
      "value": "text"
    }
  }
}

200

Tool updated successfully

{
  "id": "text",
  "type": "http",
  "name": "text",
  "modelToolName": "text",
  "description": "text",
  "baseUrlPattern": "text",
  "httpMethod": "GET",
  "dynamicParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "location": "body",
      "schema": {
        "type": "string",
        "description": "text",
        "enum": [
          "text"
        ],
        "required": true
      },
      "required": true
    }
  },
  "automaticParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "location": "body",
      "knownValue": "text"
    }
  },
  "staticParameters": {
    "ANY_ADDITIONAL_PROPERTY": {
      "location": "header",
      "value": "text"
    }
  },
  "createdAt": "2026-02-08T10:05:43.921Z"
}

Delete tool

delete

Delete a tool

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Responses

200

Tool deleted successfully

No content

delete

/agent-tools/{id}

HTTPcURLJavaScriptPython

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

200

Tool deleted successfully

No content

List system tools

get

Retrieve a list of available system tools

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Responses

200

Successful response

application/json

get

/agent-tools/system

HTTPcURLJavaScriptPython

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

200

Successful response

{
  "data": [
    {
      "toolName": "text",
      "description": "text"
    }
  ]
}

List agent tools

get

Get all tools assigned to an agent

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Agent ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Agent not found

application/json

get

/agents/{id}/tools

HTTPcURLJavaScriptPython

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

{
  "data": {
    "customTools": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "modelToolName": "text",
        "httpMethod": "text",
        "baseUrlPattern": "text",
        "type": "custom",
        "assignedAt": "2026-02-08T10:05:43.921Z"
      }
    ],
    "systemTools": [
      {
        "id": "text",
        "toolName": "text",
        "displayName": "text",
        "description": "text",
        "type": "system",
        "assignedAt": "2026-02-08T10:05:43.921Z"
      }
    ],
    "totalTools": 1
  }
}

Assign tools to agent

post

Assign one or more tools to an agent

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Agent ID

Body

application/json

toolIdsstring[] · min: 1Required

Array of tool IDs to assign

Responses

200

Tools assigned successfully

application/json

400

Invalid request or tools not found

application/json

401

Unauthorized

application/json

404

Agent not found

application/json

post

/agents/{id}/tools

HTTPcURLJavaScriptPython

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

{
  "toolIds": [
    "text"
  ]
}

{
  "message": "text",
  "assigned": 1,
  "alreadyAssigned": 1
}

Remove tool from agent

delete

Remove a tool assignment from an agent

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Agent ID

toolIdstringRequired

Tool ID

Responses

204

Tool removed successfully

401

Unauthorized

application/json

404

Agent or tool assignment not found

application/json

delete

/agents/{id}/tools/{toolId}

HTTPcURLJavaScriptPython

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

No content