Define a tool the agent can invoke. Creating it does not attach it to
anything — use POST /agents/{id}/tools for that, so one tool can serve
many agents.
type discriminates the shape. HTTP tools additionally require
httpMethod and baseUrlPattern; client tools take neither.
type
enum<string>
required
Available options:
http,
client
name
string
required
Required string length: 1 - 100
modelToolName
string
required
Must start with a letter and contain only letters, numbers, and
underscores.
Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
description
string
What the model reads to decide whether to call this tool. The most
important field on the object — most "my tool never fires" problems
are description problems.
httpMethod
enum<string>
Required for http tools.
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
baseUrlPattern
string<uri>
Required for http tools. Internal addresses are rejected —
RFC 1918 ranges, loopback, IPv6 ULA, link-local including the
cloud metadata endpoint at 169.254.169.254, and known private DNS
names.
dynamicParameters
object
Show child attributes
automaticParameters
object
Show child attributes
staticParameters
object
Show child attributes
agentReaction
enum<string>
What the agent does when the tool returns.
speaks narrates the result (default). listens stays silent and waits
— right for tools that hand off, like a transfer. speaks-once speaks
only if it did not already speak just before invoking, which prevents
"Checking that for you… here is the result…" double-talk.
Available options:
speaks,
listens,
speaks-once
timeout
string
Seconds with an s suffix, e.g. "2.5s" or "10s". Must be greater
than 0 and at most 40s. Defaults to 2.5s when unset.
Pattern: ^\d+(\.\d+)?s$
Example:
"5s"
readOnly
boolean
default:false
httpSecurityOptions
object
Declares which credentials the tool needs and how each is sent. The
secret values themselves live in authTokens.
options is a list of acceptable alternatives — satisfying any one
entry is enough, which is how you offer "either an API key or a bearer
token".
Show child attributes
authTokens
object
Plaintext credential values keyed by credential name, encrypted
before storage and never returned.
Every key must be declared in
httpSecurityOptions.options[].requirements, or the request is
rejected. This catches typos like stcokApiKey that would otherwise
persist silently and 401 against your endpoint at call time with
nothing useful in the logs.
The reverse is not required: you may declare two credentials as
alternatives and supply only one.
Show child attributes
Response
Tool created
A tool the agent can invoke during a call.
id
string
name
string
description
string | null
modelToolName
string
The function name the model sees.
type
enum<string>
Available options:
http,
client
httpMethod
enum<string>
HTTP tools only.
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
baseUrlPattern
string
HTTP tools only.
dynamicParameters
object
Show child attributes
automaticParameters
object
Show child attributes
staticParameters
object
Show child attributes
agentReaction
enum<string> | null
What the agent does when the tool returns.
speaks narrates the result (default). listens stays silent and waits
— right for tools that hand off, like a transfer. speaks-once speaks
only if it did not already speak just before invoking, which prevents
"Checking that for you… here is the result…" double-talk.
Available options:
speaks,
listens,
speaks-once
httpSecurityOptions
object | null
Declares which credentials the tool needs and how each is sent. The
secret values themselves live in authTokens.
options is a list of acceptable alternatives — satisfying any one
entry is enough, which is how you offer "either an API key or a bearer
token".
Show child attributes
setCredentials
object
Which credential slots hold a stored value. Credential values are
never returned by this API — this map exists so a UI can render
•••••••• for a set slot and an empty field for an unset one.
Show child attributes
timeout
string | null
Seconds with an s suffix, e.g. "2.5s" or "10s". Must be greater
than 0 and at most 40s. Defaults to 2.5s when unset.
Pattern: ^\d+(\.\d+)?s$
Example:
"5s"
readOnly
boolean
default:false
Attests the tool is side-effect free, letting the runtime run it
eagerly while the agent is still speaking and discard the result
if the conversation turns elsewhere. Set it only on lookups — never
on a booking or a payment.
agentCount
integer
How many agents this tool is attached to.
createdAt
string<date-time>
updatedAt
string<date-time>
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Omnia Voice","description":"Build voice AI agents that answer the phone, use your tools, and speak 50+ languages.","colors":{"primary":"#2D5A27","light":"#4A7A44","dark":"#1E3D1A"},"favicon":"https://mintcdn.com/omnia-voice/3rOHbKCRyi-xYmiI/logo/favicon.png?fit=max\u0026auto=format\u0026n=3rOHbKCRyi-xYmiI\u0026q=85\u0026s=8ec49c3bbcf6b1c4daa16f086ed58e94","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["bash","javascript","python"]},"mdx":{"auth":{"method":"key","name":"X-API-Key"},"server":"https://api.omnia-voice.com/api/v1"}},"navbar":{"links":[{"href":"https://www.omnia-voice.com","label":"Status"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.omnia-voice.com"}},"footer":{"socials":{"website":"https://www.omnia-voice.com"},"links":[{"header":"Product","items":[{"label":"Voice agents","href":"https://www.omnia-voice.com"},{"label":"Pricing","href":"https://www.omnia-voice.com/pricing"},{"label":"Dashboard","href":"https://dashboard.omnia-voice.com"}]},{"header":"Resources","items":[{"label":"Quickstart","href":"/quickstart"},{"label":"API reference","href":"/api-reference/introduction"},{"label":"Contact","href":"https://www.omnia-voice.com/contact"}]}]},"search":{"prompt":"Search the Omnia Voice docs"},"seo":{"indexing":"all"},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"omnia-voice","hasAudioNarration":false,"actualSubdomain":"omnia-voice","customDomains":["guide.omnia-voice.com"],"gitSource":{"type":"github","owner":"matiyas-h","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6aa3b79078727a81fd162b8b","clientVersion":"0.0.4271","searchFilterCounts":[{"language":"default","tag":"API Reference","count":39},{"language":"default","tag":"Documentation","count":37},{"language":"default","tag":"Tools","count":16},{"language":"default","tag":"Speech to text","count":9},{"language":"default","tag":"Get started","count":7},{"language":"default","tag":"Phone Numbers","count":6},{"language":"default","tag":"Core concepts","count":5},{"language":"default","tag":"Agents","count":5},{"language":"default","tag":"Transcription","count":5},{"language":"default","tag":"Examples","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/tools/create-a-tool","slug":"/api-reference/tools/create-a-tool","pageMetadata":{"title":"Create a tool","description":"Define a tool the agent can invoke. Creating it does not attach it to\nanything — use `POST /agents/{id}/tools` for that, so one tool can serve\nmany agents.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agent-tools","href":"/api-reference/tools/create-a-tool","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Define a tool the agent can invoke. Creating it does not attach it to\\nanything — use \", _jsx(_components.code, {\n children: \"POST /agents/{id}/tools\"\n }), \" for that, so one tool can serve\\nmany agents.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a tool","description":"Define a tool the agent can invoke. Creating it does not attach it to\nanything — use `POST /agents/{id}/tools` for that, so one tool can serve\nmany agents.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agent-tools","href":"/api-reference/tools/create-a-tool","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a tool","description":"Define a tool the agent can invoke. Creating it does not attach it to\nanything — use `POST /agents/{id}/tools` for that, so one tool can serve\nmany agents.\n","operationId":"createTool","tags":["Tools"],"requestBody":"c1725060-e3cd-4138-85a4-b8703b8eac6a","responses":{"201":"97238750-3089-49eb-a2c8-e762b66d0103","400":"f8f27f1f-69bb-48a7-94be-ff0094874299","409":"80fad2fa-e277-40b5-a0ec-b3cac2b31f4c"},"method":"post","type":"path","servers":["4940e985-75ca-4a28-be65-53fb33689518","624c1142-23eb-4342-a7a3-c36e95cc605f"],"security":["a1b8c170-9c90-4786-83cb-bf18f2e3792e"],"path":"/agent-tools","baseUrlOptions":["https://api.omnia-voice.com/api/v1","https://dashboard.omnia-voice.com/api/v1"],"title":"Create a tool","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"`type` discriminates the shape. HTTP tools additionally require\n`httpMethod` and `baseUrlPattern`; client tools take neither.\n","required":["type","name","modelToolName"],"properties":{"type":{"type":"string","enum":["http","client"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","minLength":1,"maxLength":100,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"modelToolName":{"type":"string","pattern":"^[a-zA-Z][a-zA-Z0-9_]*$","description":"Must start with a letter and contain only letters, numbers, and\nunderscores.\n","isRequired":true,"uniqueKey":"modelToolName","typeLabel":"string"},"description":{"type":"string","description":"What the model reads to decide whether to call this tool. The most\nimportant field on the object — most \"my tool never fires\" problems\nare description problems.\n","uniqueKey":"description","typeLabel":"string"},"httpMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"description":"Required for `http` tools.","uniqueKey":"httpMethod","typeLabel":"enum\u003cstring>"},"baseUrlPattern":{"type":"string","format":"uri","description":"Required for `http` tools. **Internal addresses are rejected** —\nRFC 1918 ranges, loopback, IPv6 ULA, link-local including the\ncloud metadata endpoint at 169.254.169.254, and known private DNS\nnames.\n","uniqueKey":"baseUrlPattern","typeLabel":"string\u003curi>"},"dynamicParameters":{"type":"object","additionalProperties":{"type":"object","description":"The model fills this in from the conversation.","required":["schema"],"properties":{"schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["string","number","boolean","object","array"],"isRequired":true,"uniqueKey":"dynamicParameters.additionalProperties.schema.type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"Written for the model, not for a developer. \"The customer's\norder number, usually eight digits\" beats \"order identifier\".\n","uniqueKey":"dynamicParameters.additionalProperties.schema.description","typeLabel":"string"},"enum":{"type":"array","items":{"type":"string","uniqueKey":"dynamicParameters.additionalProperties.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"dynamicParameters.additionalProperties.schema.enum","typeLabel":"string[]"},"required":{"type":"boolean","uniqueKey":"dynamicParameters.additionalProperties.schema.required","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"dynamicParameters.additionalProperties.schema","typeLabel":"object"},"location":{"type":"string","description":"Where the value goes in the HTTP request. Both the short and the\ncanonical long form are accepted on input; the long form is what is\nsent to the runtime.\n","enum":["header","query","path","body","PARAMETER_LOCATION_HEADER","PARAMETER_LOCATION_QUERY","PARAMETER_LOCATION_PATH","PARAMETER_LOCATION_BODY"],"uniqueKey":"dynamicParameters.additionalProperties.location","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","uniqueKey":"dynamicParameters.additionalProperties.required","typeLabel":"boolean"}},"uniqueKey":"dynamicParameters.additionalProperties","typeLabel":"object"},"uniqueKey":"dynamicParameters","typeLabel":"object"},"automaticParameters":{"type":"object","additionalProperties":{"type":"object","description":"Injected by the platform at call time.","required":["knownValue"],"properties":{"knownValue":{"type":"string","description":"e.g. `KNOWN_PARAM_CALL_ID` to receive the live call's ID.","isRequired":true,"uniqueKey":"automaticParameters.additionalProperties.knownValue","typeLabel":"string"},"location":{"type":"string","description":"Where the value goes in the HTTP request. Both the short and the\ncanonical long form are accepted on input; the long form is what is\nsent to the runtime.\n","enum":["header","query","path","body","PARAMETER_LOCATION_HEADER","PARAMETER_LOCATION_QUERY","PARAMETER_LOCATION_PATH","PARAMETER_LOCATION_BODY"],"uniqueKey":"automaticParameters.additionalProperties.location","typeLabel":"enum\u003cstring>"}},"uniqueKey":"automaticParameters.additionalProperties","typeLabel":"object"},"uniqueKey":"automaticParameters","typeLabel":"object"},"staticParameters":{"type":"object","additionalProperties":{"type":"object","description":"Sent on every invocation and **never exposed to the model**. Use for\ntenant IDs, API versions, feature flags — things your endpoint needs but\nthe agent has no business knowing or inventing.\n","required":["value"],"properties":{"value":{"description":"Any JSON value.","isRequired":true,"uniqueKey":"staticParameters.additionalProperties.value","typeLabel":"any"},"location":{"type":"string","description":"Where the value goes in the HTTP request. Both the short and the\ncanonical long form are accepted on input; the long form is what is\nsent to the runtime.\n","enum":["header","query","path","body","PARAMETER_LOCATION_HEADER","PARAMETER_LOCATION_QUERY","PARAMETER_LOCATION_PATH","PARAMETER_LOCATION_BODY"],"uniqueKey":"staticParameters.additionalProperties.location","typeLabel":"enum\u003cstring>"}},"uniqueKey":"staticParameters.additionalProperties","typeLabel":"object"},"uniqueKey":"staticParameters","typeLabel":"object"},"agentReaction":{"type":"string","enum":["speaks","listens","speaks-once"],"description":"What the agent does when the tool returns.\n`speaks` narrates the result (default). `listens` stays silent and waits\n— right for tools that hand off, like a transfer. `speaks-once` speaks\nonly if it did not already speak just before invoking, which prevents\n\"Checking that for you… here is the result…\" double-talk.\n","uniqueKey":"agentReaction","typeLabel":"enum\u003cstring>"},"timeout":{"type":"string","pattern":"^\\d+(\\.\\d+)?s$","description":"Seconds with an `s` suffix, e.g. `\"2.5s\"` or `\"10s\"`. Must be greater\nthan 0 and at most **40s**. Defaults to 2.5s when unset.\n","example":"5s","uniqueKey":"timeout","typeLabel":"string"},"readOnly":{"type":"boolean","default":false,"uniqueKey":"readOnly","typeLabel":"boolean"},"httpSecurityOptions":{"type":"object","description":"Declares which credentials the tool needs and how each is sent. The\nsecret values themselves live in `authTokens`.\n\n`options` is a list of **acceptable alternatives** — satisfying any one\nentry is enough, which is how you offer \"either an API key or a bearer\ntoken\".\n","required":["options"],"properties":{"options":{"type":"array","minItems":1,"items":{"type":"object","required":["requirements"],"properties":{"requirements":{"type":"object","additionalProperties":{"type":"object","description":"How one credential is transmitted. Declare **exactly one** of the three.\n","properties":{"queryApiKey":{"type":"object","description":"Sent as a query-string parameter.","properties":{"name":{"type":"string","uniqueKey":"httpSecurityOptions.options.items.[INDEX].requirements.additionalProperties.queryApiKey.name","typeLabel":"string"}},"uniqueKey":"httpSecurityOptions.options.items.[INDEX].requirements.additionalProperties.queryApiKey","typeLabel":"object"},"headerApiKey":{"type":"object","description":"Sent as a request header.","properties":{"name":{"type":"string","uniqueKey":"httpSecurityOptions.options.items.[INDEX].requirements.additionalProperties.headerApiKey.name","typeLabel":"string"}},"uniqueKey":"httpSecurityOptions.options.items.[INDEX].requirements.additionalProperties.headerApiKey","typeLabel":"object"},"httpAuth":{"type":"object","description":"Sent via the Authorization header with a scheme.","properties":{"scheme":{"type":"string","example":"Bearer","uniqueKey":"httpSecurityOptions.options.items.[INDEX].requirements.additionalProperties.httpAuth.scheme","typeLabel":"string"}},"uniqueKey":"httpSecurityOptions.options.items.[INDEX].requirements.additionalProperties.httpAuth","typeLabel":"object"}},"uniqueKey":"httpSecurityOptions.options.items.[INDEX].requirements.additionalProperties","typeLabel":"object"},"description":"Credential name → how it is sent.","isRequired":true,"uniqueKey":"httpSecurityOptions.options.items.[INDEX].requirements","typeLabel":"object"}},"uniqueKey":"httpSecurityOptions.options.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"httpSecurityOptions.options","typeLabel":"object[]"}},"uniqueKey":"httpSecurityOptions","typeLabel":"object"},"authTokens":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"authTokens.additionalProperties","typeLabel":"string"},"description":"Plaintext credential values keyed by credential name, encrypted\nbefore storage and never returned.\n\n**Every key must be declared** in\n`httpSecurityOptions.options[].requirements`, or the request is\nrejected. This catches typos like `stcokApiKey` that would otherwise\npersist silently and 401 against your endpoint at call time with\nnothing useful in the logs.\n\nThe reverse is not required: you may declare two credentials as\nalternatives and supply only one.\n","uniqueKey":"authTokens","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","modelToolName":"\u003cstring>","description":"\u003cstring>","baseUrlPattern":"\u003cstring>","dynamicParameters":{},"automaticParameters":{},"staticParameters":{},"timeout":"5s","readOnly":false,"authTokens":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"97238750-3089-49eb-a2c8-e762b66d0103":{"description":"Tool created","content":{"application/json":{"schema":{"type":"object","description":"A tool the agent can invoke during a call.","properties":{"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"modelToolName":{"type":"string","description":"The function name the model sees.","uniqueKey":"modelToolName","typeLabel":"string"},"type":{"type":"string","enum":["http","client"],"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"httpMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"description":"HTTP tools only.","uniqueKey":"httpMethod","typeLabel":"enum\u003cstring>"},"baseUrlPattern":{"type":"string","description":"HTTP tools only.","uniqueKey":"baseUrlPattern","typeLabel":"string"},"dynamicParameters":{"type":"object","additionalProperties":{"type":"object","description":"The model fills this in from the conversation.","required":["schema"],"properties":{"schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["string","number","boolean","object","array"],"isRequired":true,"uniqueKey":"dynamicParameters.additionalProperties.schema.type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"Written for the model, not for a developer. \"The customer's\norder number, usually eight digits\" beats \"order identifier\".\n","uniqueKey":"dynamicParameters.additionalProperties.schema.description","typeLabel":"string"},"enum":{"type":"array","items":{"type":"string","uniqueKey":"dynamicParameters.additionalProperties.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"dynamicParameters.additionalProperties.schema.enum","typeLabel":"string[]"},"required":{"type":"boolean","uniqueKey":"dynamicParameters.additionalProperties.schema.required","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"dynamicParameters.additionalProperties.schema","typeLabel":"object"},"location":{"type":"string","description":"Where the value goes in the HTTP request. Both the short and the\ncanonical long form are accepted on input; the long form is what is\nsent to the runtime.\n","enum":["header","query","path","body","PARAMETER_LOCATION_HEADER","PARAMETER_LOCATION_QUERY","PARAMETER_LOCATION_PATH","PARAMETER_LOCATION_BODY"],"uniqueKey":"dynamicParameters.additionalProperties.location","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","uniqueKey":"dynamicParameters.additionalProperties.required","typeLabel":"boolean"}},"uniqueKey":"dynamicParameters.additionalProperties","typeLabel":"object"},"uniqueKey":"dynamicParameters","typeLabel":"object"},"automaticParameters":{"type":"object","additionalProperties":{"type":"object","description":"Injected by the platform at call time.","required":["knownValue"],"properties":{"knownValue":{"type":"string","description":"e.g. `KNOWN_PARAM_CALL_ID` to receive the live call's ID.","isRequired":true,"uniqueKey":"automaticParameters.additionalProperties.knownValue","typeLabel":"string"},"location":{"type":"string","description":"Where the value goes in the HTTP request. Both the short and the\ncanonical long form are accepted on input; the long form is what is\nsent to the runtime.\n","enum":["header","query","path","body","PARAMETER_LOCATION_HEADER","PARAMETER_LOCATION_QUERY","PARAMETER_LOCATION_PATH","PARAMETER_LOCATION_BODY"],"uniqueKey":"automaticParameters.additionalProperties.location","typeLabel":"enum\u003cstring>"}},"uniqueKey":"automaticParameters.additionalProperties","typeLabel":"object"},"uniqueKey":"automaticParameters","typeLabel":"object"},"staticParameters":{"type":"object","additionalProperties":{"type":"object","description":"Sent on every invocation and **never exposed to the model**. Use for\ntenant IDs, API versions, feature flags — things your endpoint needs but\nthe agent has no business knowing or inventing.\n","required":["value"],"properties":{"value":{"description":"Any JSON value.","isRequired":true,"uniqueKey":"staticParameters.additionalProperties.value","typeLabel":"any"},"location":{"type":"string","description":"Where the value goes in the HTTP request. Both the short and the\ncanonical long form are accepted on input; the long form is what is\nsent to the runtime.\n","enum":["header","query","path","body","PARAMETER_LOCATION_HEADER","PARAMETER_LOCATION_QUERY","PARAMETER_LOCATION_PATH","PARAMETER_LOCATION_BODY"],"uniqueKey":"staticParameters.additionalProperties.location","typeLabel":"enum\u003cstring>"}},"uniqueKey":"staticParameters.additionalProperties","typeLabel":"object"},"uniqueKey":"staticParameters","typeLabel":"object"},"agentReaction":{"oneOf":[{"type":"string","description":"What the agent does when the tool returns.\n`speaks` narrates the result (default). `listens` stays silent and waits\n— right for tools that hand off, like a transfer. `speaks-once` speaks\nonly if it did not already speak just before invoking, which prevents\n\"Checking that for you… here is the result…\" double-talk.\n","enum":["speaks","listens","speaks-once"],"uniqueKey":"agentReaction.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"agentReaction.oneOf.1","typeLabel":"null"}],"uniqueKey":"agentReaction","typeLabel":"enum\u003cstring> | null"},"httpSecurityOptions":{"oneOf":[{"type":"object","description":"Declares which credentials the tool needs and how each is sent. The\nsecret values themselves live in `authTokens`.\n\n`options` is a list of **acceptable alternatives** — satisfying any one\nentry is enough, which is how you offer \"either an API key or a bearer\ntoken\".\n","required":["options"],"properties":{"options":{"type":"array","minItems":1,"items":{"type":"object","required":["requirements"],"properties":{"requirements":{"type":"object","additionalProperties":{"type":"object","description":"How one credential is transmitted. Declare **exactly one** of the three.\n","properties":{"queryApiKey":{"type":"object","description":"Sent as a query-string parameter.","properties":{"name":{"type":"string","uniqueKey":"httpSecurityOptions.oneOf.0.options.items.[INDEX].requirements.additionalProperties.queryApiKey.name","typeLabel":"string"}},"uniqueKey":"httpSecurityOptions.oneOf.0.options.items.[INDEX].requirements.additionalProperties.queryApiKey","typeLabel":"object"},"headerApiKey":{"type":"object","description":"Sent as a request header.","properties":{"name":{"type":"string","uniqueKey":"httpSecurityOptions.oneOf.0.options.items.[INDEX].requirements.additionalProperties.headerApiKey.name","typeLabel":"string"}},"uniqueKey":"httpSecurityOptions.oneOf.0.options.items.[INDEX].requirements.additionalProperties.headerApiKey","typeLabel":"object"},"httpAuth":{"type":"object","description":"Sent via the Authorization header with a scheme.","properties":{"scheme":{"type":"string","example":"Bearer","uniqueKey":"httpSecurityOptions.oneOf.0.options.items.[INDEX].requirements.additionalProperties.httpAuth.scheme","typeLabel":"string"}},"uniqueKey":"httpSecurityOptions.oneOf.0.options.items.[INDEX].requirements.additionalProperties.httpAuth","typeLabel":"object"}},"uniqueKey":"httpSecurityOptions.oneOf.0.options.items.[INDEX].requirements.additionalProperties","typeLabel":"object"},"description":"Credential name → how it is sent.","isRequired":true,"uniqueKey":"httpSecurityOptions.oneOf.0.options.items.[INDEX].requirements","typeLabel":"object"}},"uniqueKey":"httpSecurityOptions.oneOf.0.options.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"httpSecurityOptions.oneOf.0.options","typeLabel":"object[]"}},"uniqueKey":"httpSecurityOptions.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"httpSecurityOptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"httpSecurityOptions","typeLabel":"object | null"},"setCredentials":{"type":"object","additionalProperties":{"type":"boolean","uniqueKey":"setCredentials.additionalProperties","typeLabel":"boolean"},"description":"Which credential slots hold a stored value. **Credential values are\nnever returned by this API** — this map exists so a UI can render\n`••••••••` for a set slot and an empty field for an unset one.\n","uniqueKey":"setCredentials","typeLabel":"object"},"timeout":{"oneOf":[{"type":"string","description":"Seconds with an `s` suffix, e.g. `\"2.5s\"` or `\"10s\"`. Must be greater\nthan 0 and at most **40s**. Defaults to 2.5s when unset.\n","pattern":"^\\d+(\\.\\d+)?s$","example":"5s","uniqueKey":"timeout.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"timeout.oneOf.1","typeLabel":"null"}],"uniqueKey":"timeout","typeLabel":"string | null"},"readOnly":{"type":"boolean","default":false,"description":"Attests the tool is side-effect free, letting the runtime run it\n**eagerly** while the agent is still speaking and discard the result\nif the conversation turns elsewhere. Set it only on lookups — never\non a booking or a payment.\n","uniqueKey":"readOnly","typeLabel":"boolean"},"agentCount":{"type":"integer","description":"How many agents this tool is attached to.","uniqueKey":"agentCount","typeLabel":"integer"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","modelToolName":"\u003cstring>","type":"http","httpMethod":"GET","baseUrlPattern":"\u003cstring>","dynamicParameters":{},"automaticParameters":{},"staticParameters":{},"agentReaction":"speaks","httpSecurityOptions":{"options":[{"requirements":{}}]},"setCredentials":{},"timeout":"5s","readOnly":false,"agentCount":123,"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"f8f27f1f-69bb-48a7-94be-ff0094874299":{"description":"Validation failed. Common causes: `modelToolName` not matching\n`^[a-zA-Z][a-zA-Z0-9_]*$`; a `baseUrlPattern` pointing at an\ninternal address; a parameter name appearing in more than one of\nthe dynamic/automatic/static maps; or an `authTokens` key that is\nnot declared in `httpSecurityOptions`.\n","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"80fad2fa-e277-40b5-a0ec-b3cac2b31f4c":{"description":"A tool with that `modelToolName` already exists.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"a1b8c170-9c90-4786-83cb-bf18f2e3792e":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication","scopes":[]}}},"servers":{"4940e985-75ca-4a28-be65-53fb33689518":{"url":"https://api.omnia-voice.com/api/v1","description":"Production"},"624c1142-23eb-4342-a7a3-c36e95cc605f":{"url":"https://dashboard.omnia-voice.com/api/v1","description":"Production (alias — same service)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication","scopes":[]},"schema":{"title":"X-API-Key","type":"string","description":"API key for authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"omnia-voice","siteName":"Omnia Voice","title":"Create a tool - Omnia Voice","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-22T16:16:32.607Z","originalFileLocation":"api-reference/tools/create-a-tool.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Define a tool the agent can invoke. Creating it does not attach it to anything — use POST /agents/{id}/tools for that, so one tool can serve many agents.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Omnia Voice\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/omnia-voice/psQ0ud9GXJC8RiVI/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/omnia-voice/psQ0ud9GXJC8RiVI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/omnia-voice/psQ0ud9GXJC8RiVI/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/omnia-voice/psQ0ud9GXJC8RiVI/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/omnia-voice/psQ0ud9GXJC8RiVI/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/omnia-voice/psQ0ud9GXJC8RiVI/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/omnia-voice/psQ0ud9GXJC8RiVI/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/omnia-voice/psQ0ud9GXJC8RiVI/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/omnia-voice/psQ0ud9GXJC8RiVI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a tool - Omnia Voice\">\u003cmeta data-mint-head property=\"og:description\" content=\"Define a tool the agent can invoke. Creating it does not attach it to anything — use POST /agents/{id}/tools for that, so one tool can serve many agents.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Omnia Voice\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://guide.omnia-voice.com/api-reference/tools/create-a-tool\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://omnia-voice.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=Create+a+tool\u0026amp;description=Define+a+tool+the+agent+can+invoke.+Creating+it+does+not+attach+it+to%0Aanything+%E2%80%94+use+%60POST+%2Fagents%2F%7Bid%7D%2Ftools%60+for+that%2C+so+one+tool+can+serve%0Amany+agents.%0A\u0026amp;theme=b6060b9ef5074115255b5a12\u0026amp;signature=39861eae99e6fc0144cb38f443cbf4427a6274f78cc2da613851f197a39f805d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a tool - Omnia Voice\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Define a tool the agent can invoke. Creating it does not attach it to anything — use POST /agents/{id}/tools for that, so one tool can serve many agents.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://omnia-voice.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=Create+a+tool\u0026amp;description=Define+a+tool+the+agent+can+invoke.+Creating+it+does+not+attach+it+to%0Aanything+%E2%80%94+use+%60POST+%2Fagents%2F%7Bid%7D%2Ftools%60+for+that%2C+so+one+tool+can+serve%0Amany+agents.%0A\u0026amp;theme=b6060b9ef5074115255b5a12\u0026amp;signature=39861eae99e6fc0144cb38f443cbf4427a6274f78cc2da613851f197a39f805d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/omnia-voice/psQ0ud9GXJC8RiVI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Omnia Voice\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2D5A27\">\u003clink data-mint-head rel=\"canonical\" href=\"https://guide.omnia-voice.com/api-reference/tools/create-a-tool\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/tools/create-a-tool.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://guide.omnia-voice.com/#organization\",\"name\":\"Omnia Voice\",\"url\":\"https://guide.omnia-voice.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://guide.omnia-voice.com#website\",\"name\":\"Omnia Voice\",\"url\":\"https://guide.omnia-voice.com\",\"publisher\":{\"@id\":\"https://guide.omnia-voice.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://guide.omnia-voice.com/api-reference/tools/create-a-tool#webpage\",\"url\":\"https://guide.omnia-voice.com/api-reference/tools/create-a-tool\",\"name\":\"Create a tool\",\"description\":\"Define a tool the agent can invoke. Creating it does not attach it to anything — use POST /agents/{id}/tools for that, so one tool can serve many agents.\",\"dateModified\":\"2026-08-22T16:16:32.607Z\",\"isPartOf\":{\"@id\":\"https://guide.omnia-voice.com#website\"},\"breadcrumb\":{\"@id\":\"https://guide.omnia-voice.com/api-reference/tools/create-a-tool#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://guide.omnia-voice.com/api-reference/tools/create-a-tool#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tools\",\"item\":\"https://guide.omnia-voice.com/api-reference/tools/list-tools\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a tool\",\"item\":\"https://guide.omnia-voice.com/api-reference/tools/create-a-tool\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://guide.omnia-voice.com/api-reference/tools/create-a-tool#apireference\",\"headline\":\"Create a tool\",\"name\":\"Create a tool\",\"description\":\"Define a tool the agent can invoke. Creating it does not attach it to anything — use POST /agents/{id}/tools for that, so one tool can serve many agents.\",\"url\":\"https://guide.omnia-voice.com/api-reference/tools/create-a-tool\",\"mainEntityOfPage\":{\"@id\":\"https://guide.omnia-voice.com/api-reference/tools/create-a-tool#webpage\"},\"dateModified\":\"2026-08-22T16:16:32.607Z\",\"publisher\":{\"@id\":\"https://guide.omnia-voice.com/#organization\"},\"isPartOf\":{\"@id\":\"https://guide.omnia-voice.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Omnia Voice\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Omnia Voice\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/tools/create-a-tool.md","siteName":"Omnia Voice","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/introduction"}]},{"group":"Speech to text","pages":[{"title":"Streaming protocol","href":"/api-reference/speech-to-text/streaming"},{"group":"Transcription","pages":[{"title":"Transcribe a file","deprecated":null,"version":null,"openapi":"/openapi-stt.yaml post /transcribe","href":"/api-reference/transcription/transcribe-a-file"},{"title":"Start a long-audio transcription","deprecated":null,"version":null,"openapi":"/openapi-stt.yaml post /batch","href":"/api-reference/transcription/start-a-long-audio-transcription"},{"title":"Start a large-file upload","deprecated":null,"version":null,"openapi":"/openapi-stt.yaml post /batch/init","href":"/api-reference/transcription/start-a-large-file-upload"},{"title":"Begin recognition after upload","deprecated":null,"version":null,"openapi":"/openapi-stt.yaml post /batch/{operationId}/start","href":"/api-reference/transcription/begin-recognition-after-upload"},{"title":"Poll a long-audio transcription","deprecated":null,"version":null,"openapi":"/openapi-stt.yaml get /batch/{operationId}","href":"/api-reference/transcription/poll-a-long-audio-transcription"}]},{"group":"Languages","pages":[{"title":"List supported languages","deprecated":null,"version":null,"openapi":"/openapi-stt.yaml get /languages","href":"/api-reference/languages/list-supported-languages"}]}]},{"group":"Tools","pages":[{"title":"List tools","description":null,"deprecated":null,"version":null,"openapi":"/openapi.yaml get /agent-tools","href":"/api-reference/tools/list-tools"},{"title":"Create a tool","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agent-tools","href":"/api-reference/tools/create-a-tool"},{"title":"Get a tool","description":null,"deprecated":null,"version":null,"openapi":"/openapi.yaml get /agent-tools/{id}","href":"/api-reference/tools/get-a-tool"},{"title":"Delete a tool","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agent-tools/{id}","href":"/api-reference/tools/delete-a-tool"},{"title":"Update a tool (partial)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agent-tools/{id}","href":"/api-reference/tools/update-a-tool-partial"},{"title":"List system tools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agent-tools/system","href":"/api-reference/tools/list-system-tools"},{"title":"List agent tools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{id}/tools","href":"/api-reference/tools/list-agent-tools"},{"title":"Assign tools to agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{id}/tools","href":"/api-reference/tools/assign-tools-to-agent"},{"title":"Remove tool from agent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agents/{id}/tools/{toolId}","href":"/api-reference/tools/remove-tool-from-agent"}]},{"group":"Calls","pages":[{"title":"Place an outbound call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /calls/outbound","href":"/api-reference/calls/place-an-outbound-call"},{"title":"Create a call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /calls","href":"/api-reference/calls/create-a-call"},{"title":"Create a call for your own telephony","deprecated":null,"version":null,"openapi":"/openapi.yaml post /calls/create","href":"/api-reference/calls/create-a-call-for-your-own-telephony"},{"title":"Create a call with inline configuration","deprecated":null,"version":null,"openapi":"/openapi.yaml post /calls/inline","href":"/api-reference/calls/create-a-call-with-inline-configuration"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents","href":"/api-reference/agents/list-agents"},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents","href":"/api-reference/agents/create-agent"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{id}","href":"/api-reference/agents/get-agent"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agents/{id}","href":"/api-reference/agents/delete-agent"},{"title":"Update agent (partial)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agents/{id}","href":"/api-reference/agents/update-agent-partial"}]},{"group":"Phone Numbers","pages":[{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"title":"Assign phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /numbers","href":"/api-reference/phone-numbers/assign-phone-number"},{"title":"Get phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /numbers/{id}","href":"/api-reference/phone-numbers/get-phone-number"},{"title":"Delete phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /numbers/{id}","href":"/api-reference/phone-numbers/delete-phone-number"},{"title":"Update phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /numbers/{id}","href":"/api-reference/phone-numbers/update-phone-number"},{"title":"Get agent phone numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{id}/numbers","href":"/api-reference/phone-numbers/get-agent-phone-numbers"}]},{"group":"Call Logs","pages":[{"title":"List call logs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /calls","href":"/api-reference/call-logs/list-call-logs"},{"title":"Get call details","deprecated":null,"version":null,"openapi":"/openapi.yaml get /calls/{id}","href":"/api-reference/call-logs/get-call-details"},{"title":"Delete a call","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /calls/{id}","href":"/api-reference/call-logs/delete-a-call"}]},{"group":"Configuration","pages":[{"title":"List voices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /voices","href":"/api-reference/configuration/list-voices"},{"title":"List languages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /languages","href":"/api-reference/configuration/list-languages"}]},{"group":"Pricing","pages":[{"title":"Get pricing","deprecated":null,"version":null,"openapi":"/openapi.yaml get /pricing","href":"/api-reference/pricing/get-pricing"},{"title":"Get call pricing","deprecated":null,"version":null,"openapi":"/openapi.yaml get /pricing/calls/{id}","href":"/api-reference/pricing/get-call-pricing"}]}]}]},"basePath":"","title":"Create a tool - Omnia Voice","deploymentId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","buildId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-_HcdDqS2.js","snippetPresets-CXnm-WO6.js","utils-Dg59J__o.js","style-to-object-BY3JEAdk.js","utils-D8TRpdk7.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-B6QaxWc5.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DeMZ-lcM.js","_Uint8Array-BjA2mcVW.js","isObject-FP1Yky1u.js","ApiExamples-cjPyMv63.js","usePlaygroundInputsStore-D7BWoaw4.js","shallow-Z1ceDNSG.js","isEqual-BObTuQrO.js","CodeSnippets-D1UZ1AE-.js","CodeSnippet-B373COAT.js","getApiPlaygroundDisplay-CfL-UuDS.js","Page-DuqezyvM.js","DynamicMarkdown-5yMTCLas.js","SectionHeading-BxT1HYfP.js","icon-DYJTTD3g.js","MethodPill-4AyycJeu.js","getPastedJson-Bp3WV6cN.js","Check2Icon-PhZu6Gry.js","axios-CsQoIw0U.js","Markdown-Dy9a8hT8.js","AssistantPageLink-87tSPwGm.js","dist-CXMB3QQU.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}