Skip to main content
POST
/
api
/
tools
cURL
curl --request POST \
  --url https://api.ultravox.ai/api/tools \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "definition": {
    "modelToolName": "<string>",
    "description": "<string>",
    "dynamicParameters": [
      {
        "name": "<string>",
        "location": "PARAMETER_LOCATION_UNSPECIFIED",
        "schema": {},
        "required": true
      }
    ],
    "staticParameters": [
      {
        "name": "<string>",
        "location": "PARAMETER_LOCATION_UNSPECIFIED",
        "value": "<any>"
      }
    ],
    "automaticParameters": [
      {
        "name": "<string>",
        "location": "PARAMETER_LOCATION_UNSPECIFIED",
        "knownValue": "KNOWN_PARAM_UNSPECIFIED"
      }
    ],
    "requirements": {
      "httpSecurityOptions": {
        "options": [
          {
            "requirements": {},
            "ultravoxCallTokenRequirement": {
              "scopes": [
                "<string>"
              ]
            }
          }
        ]
      },
      "requiredParameterOverrides": [
        "<string>"
      ]
    },
    "timeout": "<string>",
    "precomputable": true,
    "http": {
      "baseUrlPattern": "<string>",
      "httpMethod": "<string>"
    },
    "client": {},
    "dataConnection": {},
    "defaultReaction": "AGENT_REACTION_UNSPECIFIED",
    "staticResponse": {
      "responseText": "<string>"
    }
  }
}'
{
  "toolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "definition": {
    "modelToolName": "<string>",
    "description": "<string>",
    "dynamicParameters": [
      {
        "name": "<string>",
        "location": "PARAMETER_LOCATION_UNSPECIFIED",
        "schema": {},
        "required": true
      }
    ],
    "staticParameters": [
      {
        "name": "<string>",
        "location": "PARAMETER_LOCATION_UNSPECIFIED",
        "value": "<any>"
      }
    ],
    "automaticParameters": [
      {
        "name": "<string>",
        "location": "PARAMETER_LOCATION_UNSPECIFIED",
        "knownValue": "KNOWN_PARAM_UNSPECIFIED"
      }
    ],
    "requirements": {
      "httpSecurityOptions": {
        "options": [
          {
            "requirements": {},
            "ultravoxCallTokenRequirement": {
              "scopes": [
                "<string>"
              ]
            }
          }
        ]
      },
      "requiredParameterOverrides": [
        "<string>"
      ]
    },
    "timeout": "<string>",
    "precomputable": true,
    "http": {
      "baseUrlPattern": "<string>",
      "httpMethod": "<string>"
    },
    "client": {},
    "dataConnection": {},
    "defaultReaction": "AGENT_REACTION_UNSPECIFIED",
    "staticResponse": {
      "responseText": "<string>"
    }
  },
  "ownership": "public"
}

Authorizations

​
X-API-Key
string
header
required

API key

Body

​
name
string
required
Maximum length: 40
​
definition
object
required

The base definition of a tool that can be used during a call. Exactly one implementation (http or client) should be set.

Response

201 - application/json
​
toolId
string<uuid>
required
​
name
string
required
Maximum length: 40
​
created
string<date-time>
required
​
definition
object
required

The base definition of a tool that can be used during a call. Exactly one implementation (http or client) should be set.

​
ownership
enum<string>
required
Available options:
public,
private