Create Tool

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>",
        "schema": {},
        "required": true
      }
    ],
    "staticParameters": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ],
    "automaticParameters": [
      {
        "name": "<string>"
      }
    ],
    "requirements": {
      "httpSecurityOptions": {
        "options": [
          {
            "requirements": {},
            "ultravoxCallTokenRequirement": {
              "scopes": [
                "<string>"
              ]
            }
          }
        ]
      },
      "requiredParameterOverrides": [
        "<string>"
      ]
    },
    "timeout": "<string>",
    "precomputable": true,
    "http": {
      "baseUrlPattern": "<string>",
      "httpMethod": "<string>"
    },
    "client": {},
    "dataConnection": {},
    "staticResponse": {
      "responseText": "<string>"
    }
  }
}
'

import requests

url = "https://api.ultravox.ai/api/tools"

payload = {
    "name": "<string>",
    "definition": {
        "modelToolName": "<string>",
        "description": "<string>",
        "dynamicParameters": [
            {
                "name": "<string>",
                "schema": {},
                "required": True
            }
        ],
        "staticParameters": [
            {
                "name": "<string>",
                "value": "<unknown>"
            }
        ],
        "automaticParameters": [{ "name": "<string>" }],
        "requirements": {
            "httpSecurityOptions": { "options": [
                    {
                        "requirements": {},
                        "ultravoxCallTokenRequirement": { "scopes": ["<string>"] }
                    }
                ] },
            "requiredParameterOverrides": ["<string>"]
        },
        "timeout": "<string>",
        "precomputable": True,
        "http": {
            "baseUrlPattern": "<string>",
            "httpMethod": "<string>"
        },
        "client": {},
        "dataConnection": {},
        "staticResponse": { "responseText": "<string>" }
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    definition: {
      modelToolName: '<string>',
      description: '<string>',
      dynamicParameters: [{name: '<string>', schema: {}, required: true}],
      staticParameters: [{name: '<string>', value: '<unknown>'}],
      automaticParameters: [{name: '<string>'}],
      requirements: {
        httpSecurityOptions: {
          options: [{requirements: {}, ultravoxCallTokenRequirement: {scopes: ['<string>']}}]
        },
        requiredParameterOverrides: ['<string>']
      },
      timeout: '<string>',
      precomputable: true,
      http: {baseUrlPattern: '<string>', httpMethod: '<string>'},
      client: {},
      dataConnection: {},
      staticResponse: {responseText: '<string>'}
    }
  })
};

fetch('https://api.ultravox.ai/api/tools', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ultravox.ai/api/tools",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'definition' => [
        'modelToolName' => '<string>',
        'description' => '<string>',
        'dynamicParameters' => [
                [
                                'name' => '<string>',
                                'schema' => [
                                                                
                                ],
                                'required' => true
                ]
        ],
        'staticParameters' => [
                [
                                'name' => '<string>',
                                'value' => '<unknown>'
                ]
        ],
        'automaticParameters' => [
                [
                                'name' => '<string>'
                ]
        ],
        'requirements' => [
                'httpSecurityOptions' => [
                                'options' => [
                                                                [
                                                                                                                                'requirements' => [
                                                                                                                                                                                                                                                                
                                                                                                                                ],
                                                                                                                                'ultravoxCallTokenRequirement' => [
                                                                                                                                                                                                                                                                'scopes' => [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                                                                                                                                                ]
                                                                                                                                ]
                                                                ]
                                ]
                ],
                'requiredParameterOverrides' => [
                                '<string>'
                ]
        ],
        'timeout' => '<string>',
        'precomputable' => true,
        'http' => [
                'baseUrlPattern' => '<string>',
                'httpMethod' => '<string>'
        ],
        'client' => [
                
        ],
        'dataConnection' => [
                
        ],
        'staticResponse' => [
                'responseText' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ultravox.ai/api/tools"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"definition\": {\n    \"modelToolName\": \"<string>\",\n    \"description\": \"<string>\",\n    \"dynamicParameters\": [\n      {\n        \"name\": \"<string>\",\n        \"schema\": {},\n        \"required\": true\n      }\n    ],\n    \"staticParameters\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<unknown>\"\n      }\n    ],\n    \"automaticParameters\": [\n      {\n        \"name\": \"<string>\"\n      }\n    ],\n    \"requirements\": {\n      \"httpSecurityOptions\": {\n        \"options\": [\n          {\n            \"requirements\": {},\n            \"ultravoxCallTokenRequirement\": {\n              \"scopes\": [\n                \"<string>\"\n              ]\n            }\n          }\n        ]\n      },\n      \"requiredParameterOverrides\": [\n        \"<string>\"\n      ]\n    },\n    \"timeout\": \"<string>\",\n    \"precomputable\": true,\n    \"http\": {\n      \"baseUrlPattern\": \"<string>\",\n      \"httpMethod\": \"<string>\"\n    },\n    \"client\": {},\n    \"dataConnection\": {},\n    \"staticResponse\": {\n      \"responseText\": \"<string>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.ultravox.ai/api/tools")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"definition\": {\n    \"modelToolName\": \"<string>\",\n    \"description\": \"<string>\",\n    \"dynamicParameters\": [\n      {\n        \"name\": \"<string>\",\n        \"schema\": {},\n        \"required\": true\n      }\n    ],\n    \"staticParameters\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<unknown>\"\n      }\n    ],\n    \"automaticParameters\": [\n      {\n        \"name\": \"<string>\"\n      }\n    ],\n    \"requirements\": {\n      \"httpSecurityOptions\": {\n        \"options\": [\n          {\n            \"requirements\": {},\n            \"ultravoxCallTokenRequirement\": {\n              \"scopes\": [\n                \"<string>\"\n              ]\n            }\n          }\n        ]\n      },\n      \"requiredParameterOverrides\": [\n        \"<string>\"\n      ]\n    },\n    \"timeout\": \"<string>\",\n    \"precomputable\": true,\n    \"http\": {\n      \"baseUrlPattern\": \"<string>\",\n      \"httpMethod\": \"<string>\"\n    },\n    \"client\": {},\n    \"dataConnection\": {},\n    \"staticResponse\": {\n      \"responseText\": \"<string>\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ultravox.ai/api/tools")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"definition\": {\n    \"modelToolName\": \"<string>\",\n    \"description\": \"<string>\",\n    \"dynamicParameters\": [\n      {\n        \"name\": \"<string>\",\n        \"schema\": {},\n        \"required\": true\n      }\n    ],\n    \"staticParameters\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<unknown>\"\n      }\n    ],\n    \"automaticParameters\": [\n      {\n        \"name\": \"<string>\"\n      }\n    ],\n    \"requirements\": {\n      \"httpSecurityOptions\": {\n        \"options\": [\n          {\n            \"requirements\": {},\n            \"ultravoxCallTokenRequirement\": {\n              \"scopes\": [\n                \"<string>\"\n              ]\n            }\n          }\n        ]\n      },\n      \"requiredParameterOverrides\": [\n        \"<string>\"\n      ]\n    },\n    \"timeout\": \"<string>\",\n    \"precomputable\": true,\n    \"http\": {\n      \"baseUrlPattern\": \"<string>\",\n      \"httpMethod\": \"<string>\"\n    },\n    \"client\": {},\n    \"dataConnection\": {},\n    \"staticResponse\": {\n      \"responseText\": \"<string>\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "toolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "definition": {
    "modelToolName": "<string>",
    "description": "<string>",
    "dynamicParameters": [
      {
        "name": "<string>",
        "schema": {},
        "required": true
      }
    ],
    "staticParameters": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ],
    "automaticParameters": [
      {
        "name": "<string>"
      }
    ],
    "requirements": {
      "httpSecurityOptions": {
        "options": [
          {
            "requirements": {},
            "ultravoxCallTokenRequirement": {
              "scopes": [
                "<string>"
              ]
            }
          }
        ]
      },
      "requiredParameterOverrides": [
        "<string>"
      ]
    },
    "timeout": "<string>",
    "precomputable": true,
    "http": {
      "baseUrlPattern": "<string>",
      "httpMethod": "<string>"
    },
    "client": {},
    "dataConnection": {},
    "staticResponse": {
      "responseText": "<string>"
    }
  }
}