Update a tool

Update a tool

curl --request PATCH \
  --url https://app.miyon.ai/api/v2/tools/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "method": "<string>",
  "headers": {},
  "fixed_parameters": {},
  "name": "<string>",
  "access_token": "<string>",
  "oauth_provider_id": 123,
  "say_before": "<string>",
  "condition": "<string>",
  "agent_override_condition": "<string>",
  "response_fields": [
    "<string>"
  ],
  "response_variables": [
    {
      "key": "<string>",
      "path": "<string>",
      "default_value": "<string>"
    }
  ],
  "prompt_id": 123,
  "agent_id": 123
}
'

import requests

url = "https://app.miyon.ai/api/v2/tools/{id}"

payload = {
    "url": "<string>",
    "method": "<string>",
    "headers": {},
    "fixed_parameters": {},
    "name": "<string>",
    "access_token": "<string>",
    "oauth_provider_id": 123,
    "say_before": "<string>",
    "condition": "<string>",
    "agent_override_condition": "<string>",
    "response_fields": ["<string>"],
    "response_variables": [
        {
            "key": "<string>",
            "path": "<string>",
            "default_value": "<string>"
        }
    ],
    "prompt_id": 123,
    "agent_id": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    method: '<string>',
    headers: {},
    fixed_parameters: {},
    name: '<string>',
    access_token: '<string>',
    oauth_provider_id: 123,
    say_before: '<string>',
    condition: '<string>',
    agent_override_condition: '<string>',
    response_fields: ['<string>'],
    response_variables: [{key: '<string>', path: '<string>', default_value: '<string>'}],
    prompt_id: 123,
    agent_id: 123
  })
};

fetch('https://app.miyon.ai/api/v2/tools/{id}', 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://app.miyon.ai/api/v2/tools/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'method' => '<string>',
    'headers' => [
        
    ],
    'fixed_parameters' => [
        
    ],
    'name' => '<string>',
    'access_token' => '<string>',
    'oauth_provider_id' => 123,
    'say_before' => '<string>',
    'condition' => '<string>',
    'agent_override_condition' => '<string>',
    'response_fields' => [
        '<string>'
    ],
    'response_variables' => [
        [
                'key' => '<string>',
                'path' => '<string>',
                'default_value' => '<string>'
        ]
    ],
    'prompt_id' => 123,
    'agent_id' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://app.miyon.ai/api/v2/tools/{id}"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"method\": \"<string>\",\n  \"headers\": {},\n  \"fixed_parameters\": {},\n  \"name\": \"<string>\",\n  \"access_token\": \"<string>\",\n  \"oauth_provider_id\": 123,\n  \"say_before\": \"<string>\",\n  \"condition\": \"<string>\",\n  \"agent_override_condition\": \"<string>\",\n  \"response_fields\": [\n    \"<string>\"\n  ],\n  \"response_variables\": [\n    {\n      \"key\": \"<string>\",\n      \"path\": \"<string>\",\n      \"default_value\": \"<string>\"\n    }\n  ],\n  \"prompt_id\": 123,\n  \"agent_id\": 123\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://app.miyon.ai/api/v2/tools/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"method\": \"<string>\",\n  \"headers\": {},\n  \"fixed_parameters\": {},\n  \"name\": \"<string>\",\n  \"access_token\": \"<string>\",\n  \"oauth_provider_id\": 123,\n  \"say_before\": \"<string>\",\n  \"condition\": \"<string>\",\n  \"agent_override_condition\": \"<string>\",\n  \"response_fields\": [\n    \"<string>\"\n  ],\n  \"response_variables\": [\n    {\n      \"key\": \"<string>\",\n      \"path\": \"<string>\",\n      \"default_value\": \"<string>\"\n    }\n  ],\n  \"prompt_id\": 123,\n  \"agent_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.miyon.ai/api/v2/tools/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"method\": \"<string>\",\n  \"headers\": {},\n  \"fixed_parameters\": {},\n  \"name\": \"<string>\",\n  \"access_token\": \"<string>\",\n  \"oauth_provider_id\": 123,\n  \"say_before\": \"<string>\",\n  \"condition\": \"<string>\",\n  \"agent_override_condition\": \"<string>\",\n  \"response_fields\": [\n    \"<string>\"\n  ],\n  \"response_variables\": [\n    {\n      \"key\": \"<string>\",\n      \"path\": \"<string>\",\n      \"default_value\": \"<string>\"\n    }\n  ],\n  \"prompt_id\": 123,\n  \"agent_id\": 123\n}"

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

{
  "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
}

PATCH

api

tools

{id}

Update a tool

curl --request PATCH \
  --url https://app.miyon.ai/api/v2/tools/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "method": "<string>",
  "headers": {},
  "fixed_parameters": {},
  "name": "<string>",
  "access_token": "<string>",
  "oauth_provider_id": 123,
  "say_before": "<string>",
  "condition": "<string>",
  "agent_override_condition": "<string>",
  "response_fields": [
    "<string>"
  ],
  "response_variables": [
    {
      "key": "<string>",
      "path": "<string>",
      "default_value": "<string>"
    }
  ],
  "prompt_id": 123,
  "agent_id": 123
}
'

import requests

url = "https://app.miyon.ai/api/v2/tools/{id}"

payload = {
    "url": "<string>",
    "method": "<string>",
    "headers": {},
    "fixed_parameters": {},
    "name": "<string>",
    "access_token": "<string>",
    "oauth_provider_id": 123,
    "say_before": "<string>",
    "condition": "<string>",
    "agent_override_condition": "<string>",
    "response_fields": ["<string>"],
    "response_variables": [
        {
            "key": "<string>",
            "path": "<string>",
            "default_value": "<string>"
        }
    ],
    "prompt_id": 123,
    "agent_id": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    method: '<string>',
    headers: {},
    fixed_parameters: {},
    name: '<string>',
    access_token: '<string>',
    oauth_provider_id: 123,
    say_before: '<string>',
    condition: '<string>',
    agent_override_condition: '<string>',
    response_fields: ['<string>'],
    response_variables: [{key: '<string>', path: '<string>', default_value: '<string>'}],
    prompt_id: 123,
    agent_id: 123
  })
};

fetch('https://app.miyon.ai/api/v2/tools/{id}', 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://app.miyon.ai/api/v2/tools/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'method' => '<string>',
    'headers' => [
        
    ],
    'fixed_parameters' => [
        
    ],
    'name' => '<string>',
    'access_token' => '<string>',
    'oauth_provider_id' => 123,
    'say_before' => '<string>',
    'condition' => '<string>',
    'agent_override_condition' => '<string>',
    'response_fields' => [
        '<string>'
    ],
    'response_variables' => [
        [
                'key' => '<string>',
                'path' => '<string>',
                'default_value' => '<string>'
        ]
    ],
    'prompt_id' => 123,
    'agent_id' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://app.miyon.ai/api/v2/tools/{id}"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"method\": \"<string>\",\n  \"headers\": {},\n  \"fixed_parameters\": {},\n  \"name\": \"<string>\",\n  \"access_token\": \"<string>\",\n  \"oauth_provider_id\": 123,\n  \"say_before\": \"<string>\",\n  \"condition\": \"<string>\",\n  \"agent_override_condition\": \"<string>\",\n  \"response_fields\": [\n    \"<string>\"\n  ],\n  \"response_variables\": [\n    {\n      \"key\": \"<string>\",\n      \"path\": \"<string>\",\n      \"default_value\": \"<string>\"\n    }\n  ],\n  \"prompt_id\": 123,\n  \"agent_id\": 123\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://app.miyon.ai/api/v2/tools/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"method\": \"<string>\",\n  \"headers\": {},\n  \"fixed_parameters\": {},\n  \"name\": \"<string>\",\n  \"access_token\": \"<string>\",\n  \"oauth_provider_id\": 123,\n  \"say_before\": \"<string>\",\n  \"condition\": \"<string>\",\n  \"agent_override_condition\": \"<string>\",\n  \"response_fields\": [\n    \"<string>\"\n  ],\n  \"response_variables\": [\n    {\n      \"key\": \"<string>\",\n      \"path\": \"<string>\",\n      \"default_value\": \"<string>\"\n    }\n  ],\n  \"prompt_id\": 123,\n  \"agent_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.miyon.ai/api/v2/tools/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"method\": \"<string>\",\n  \"headers\": {},\n  \"fixed_parameters\": {},\n  \"name\": \"<string>\",\n  \"access_token\": \"<string>\",\n  \"oauth_provider_id\": 123,\n  \"say_before\": \"<string>\",\n  \"condition\": \"<string>\",\n  \"agent_override_condition\": \"<string>\",\n  \"response_fields\": [\n    \"<string>\"\n  ],\n  \"response_variables\": [\n    {\n      \"key\": \"<string>\",\n      \"path\": \"<string>\",\n      \"default_value\": \"<string>\"\n    }\n  ],\n  \"prompt_id\": 123,\n  \"agent_id\": 123\n}"

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

{
  "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.

Pfadparameter

integer

erforderlich

ID of the tool.

Body

application/json

API tool
Built-in or provider tool

Partial update. Only keys present in the body change. "" or null clears access_token, oauth_provider_id, headers, fixed_parameters and response_fields.

url

string

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

Pattern: ^https?://

method

string

HTTP method, for example GET or POST.

headers

object | null

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 | null

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

function_definition

object

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

Show child attributes

name

string

Must equal function_definition.name.

access_token

string | null

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 | null

Phrase the agent says before calling the API.

condition

string | null

When the agent should use this tool.

agent_override_condition

string | null

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

response_fields

string[] | null

Fields of the API response the agent may use.

response_variables

object[] | null

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

Show child attributes

prompt_id

integer

veraltet

Deprecated alias of agent_id.

agent_id

integer

Voice agent that agent_override_condition applies to.

Antwort

The updated 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

Autorisierungen

Pfadparameter

Body

Antwort