curl --request POST \
  --url https://app.miyon.ai/api/v2/tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "function_type": "external:api",
  "url": "https://api.example.com/customers/{{customer_number}}",
  "method": "GET",
  "headers": {
    "Authorization": "Bearer {{api_key}}"
  },
  "access_token": "example-api-key",
  "function_definition": {
    "type": "function",
    "name": "get_customer",
    "description": "Look up a customer by customer number.",
    "parameters": {
      "type": "object",
      "properties": {
        "customer_number": {
          "type": "string"
        }
      },
      "required": [
        "customer_number"
      ]
    }
  },
  "agent_id": 123
}
'

{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "function_type": "external:api",
  "integration_id": 123,
  "ai_action_id": 123,
  "external_api": {
    "url": "<string>",
    "method": "<string>",
    "headers": {},
    "fixed_parameters": {},
    "access_token_set": true,
    "oauth_provider_id": 123,
    "say_before": "<string>",
    "condition": "<string>",
    "response_fields": [
      "<string>"
    ],
    "response_variables": [
      {
        "key": "<string>",
        "path": "<string>",
        "default_value": "<string>"
      }
    ]
  },
  "function_definition": {},
  "enabled_for_agent": true
}

Tools

Create a tool

Create a tool. Two payload shapes exist:

function_type: external:api creates an API tool from a url and an OpenAI-style function_definition.
Any other function_type with creatable_via_api: true in GET /api/v2/tools/types creates a built-in or provider-backed tool from its template; pass type-specific settings in params.

Behaviours that belong to the agent itself (system:end_call, system:transfer_call, system:check_forward_availability, system:check_warm_transfer_availability, system:get_caller_info, system:extract_intent, system:chat_handover) are not creatable and are rejected with mf-core:tool-invalid-function-type. Call forwarding (system:forward_call), warm transfer (system:warm_transfer) and DTMF input (system:dtmf_input) are configurable and stay creatable.

Cal.com tools (cal:get_availability, cal:book_appointment) require params.eventTypeId and params.timezone; a missing or invalid value is rejected with mf-core:tool-validation-failed and details.missing_param names the key.

Call-forwarding and warm-transfer types create two tools (a check and an execute tool) and return both in tools.

POST

api

tools

curl --request POST \
  --url https://app.miyon.ai/api/v2/tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "function_type": "external:api",
  "url": "https://api.example.com/customers/{{customer_number}}",
  "method": "GET",
  "headers": {
    "Authorization": "Bearer {{api_key}}"
  },
  "access_token": "example-api-key",
  "function_definition": {
    "type": "function",
    "name": "get_customer",
    "description": "Look up a customer by customer number.",
    "parameters": {
      "type": "object",
      "properties": {
        "customer_number": {
          "type": "string"
        }
      },
      "required": [
        "customer_number"
      ]
    }
  },
  "agent_id": 123
}
'

{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "function_type": "external:api",
  "integration_id": 123,
  "ai_action_id": 123,
  "external_api": {
    "url": "<string>",
    "method": "<string>",
    "headers": {},
    "fixed_parameters": {},
    "access_token_set": true,
    "oauth_provider_id": 123,
    "say_before": "<string>",
    "condition": "<string>",
    "response_fields": [
      "<string>"
    ],
    "response_variables": [
      {
        "key": "<string>",
        "path": "<string>",
        "default_value": "<string>"
      }
    ]
  },
  "function_definition": {},
  "enabled_for_agent": true
}

Autorisierungen

Authorization

string

header

erforderlich

Scoped API token. Required scopes are listed on each operation in x-required-scopes.

Body

application/json

API tool
Built-in or provider tool

Create an API tool. integration_id is ignored; the backing integration is created automatically.

function_type

string

erforderlich

Must be external:api.

Allowed value: "external:api"

url

string

erforderlich

URL to call. {{param}} placeholders are filled from the call arguments.

Pattern: ^https?://

function_definition

object

erforderlich

OpenAI-style function schema. Its name becomes the tool name.

Show child attributes

method

string

Standard:GET

HTTP method, for example GET or POST.

headers

object

Request headers. {{param}} placeholders are filled from the call arguments; {{api_key}} resolves to the access token or OAuth token.

Show child attributes

fixed_parameters

object

Values always sent with the request, not chosen by the agent.

name

string

Optional. Must equal function_definition.name.

access_token

string

Mutually exclusive with oauth_provider_id.

oauth_provider_id

integer | null

ID of an OAuth connection in your account. Mutually exclusive with access_token.

say_before

string

Phrase the agent says before calling the API.

condition

string

When the agent should use this tool.

agent_override_condition

string

Condition override for one agent. Only applied when agent_id is given.

response_fields

string[]

Fields of the API response the agent may use.

response_variables

object[]

Values extracted from the response and stored as variables for later steps.

Maximum array length: 25

Show child attributes

prompt_id

integer

veraltet

Deprecated alias of agent_id (the agent's prompt id).

agent_id

integer

Enable the tool for this voice agent right away.

Antwort

The created tool, or tool pair.

API tool
Built-in or provider tool
Tool pair

Returned by create and update. Call-forwarding and warm-transfer types return the pair.

integer

erforderlich

ID of the tool.

name

string

erforderlich

Tool name as the agent's model sees it. Equals function_definition.name.

description

string | null

erforderlich

What the tool does. Empty for API tools; the model reads function_definition.description.

function_type

string

erforderlich

Always external:api.

Allowed value: "external:api"

integration_id

integer

erforderlich

ID of the integration created for this tool.

ai_action_id

integer | null

erforderlich

ID of the action record backing this tool.

external_api

object

erforderlich

How the API is called.

Show child attributes

function_definition

object

erforderlich

OpenAI-style function schema the agent's model uses to decide when and how to call the tool.

enabled_for_agent

boolean

Only returned by create. True when agent_id was supplied and the tool was enabled for that agent.

Get started

Voice Agents

Voice Agent Settings

Tools

Outbound Calls

Conversations

Evals

Create a tool

Autorisierungen

Body

Antwort