Bind tools to an agent
curl --request PUT \
--url https://api.pyai.com/v1/agents/{id}/tools \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"tool_id": "<string>",
"enabled": true,
"config": {},
"name": "<string>",
"description": "<string>",
"input_schema": {}
}
]
'import requests
url = "https://api.pyai.com/v1/agents/{id}/tools"
payload = [
{
"tool_id": "<string>",
"enabled": True,
"config": {},
"name": "<string>",
"description": "<string>",
"input_schema": {}
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
tool_id: '<string>',
enabled: true,
config: {},
name: '<string>',
description: '<string>',
input_schema: {}
}
])
};
fetch('https://api.pyai.com/v1/agents/{id}/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.pyai.com/v1/agents/{id}/tools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
[
'tool_id' => '<string>',
'enabled' => true,
'config' => [
],
'name' => '<string>',
'description' => '<string>',
'input_schema' => [
]
]
]),
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://api.pyai.com/v1/agents/{id}/tools"
payload := strings.NewReader("[\n {\n \"tool_id\": \"<string>\",\n \"enabled\": true,\n \"config\": {},\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"input_schema\": {}\n }\n]")
req, _ := http.NewRequest("PUT", 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.put("https://api.pyai.com/v1/agents/{id}/tools")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"tool_id\": \"<string>\",\n \"enabled\": true,\n \"config\": {},\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"input_schema\": {}\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pyai.com/v1/agents/{id}/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"tool_id\": \"<string>\",\n \"enabled\": true,\n \"config\": {},\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"input_schema\": {}\n }\n]"
response = http.request(request)
puts response.read_body{
"object": "list",
"data": [
{
"tool_id": "<string>",
"enabled": true,
"config": {},
"name": "<string>",
"description": "<string>",
"input_schema": {}
}
]
}{
"error": {
"message": "<string>",
"type": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"param": "<string>"
}
}Agents
Bind tools to an agent
Replace the agent’s tool bindings. Each entry references a tool id from GET /v1/tools. Requires the omni:session scope.
PUT
/
v1
/
agents
/
{id}
/
tools
Bind tools to an agent
curl --request PUT \
--url https://api.pyai.com/v1/agents/{id}/tools \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"tool_id": "<string>",
"enabled": true,
"config": {},
"name": "<string>",
"description": "<string>",
"input_schema": {}
}
]
'import requests
url = "https://api.pyai.com/v1/agents/{id}/tools"
payload = [
{
"tool_id": "<string>",
"enabled": True,
"config": {},
"name": "<string>",
"description": "<string>",
"input_schema": {}
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
tool_id: '<string>',
enabled: true,
config: {},
name: '<string>',
description: '<string>',
input_schema: {}
}
])
};
fetch('https://api.pyai.com/v1/agents/{id}/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.pyai.com/v1/agents/{id}/tools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
[
'tool_id' => '<string>',
'enabled' => true,
'config' => [
],
'name' => '<string>',
'description' => '<string>',
'input_schema' => [
]
]
]),
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://api.pyai.com/v1/agents/{id}/tools"
payload := strings.NewReader("[\n {\n \"tool_id\": \"<string>\",\n \"enabled\": true,\n \"config\": {},\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"input_schema\": {}\n }\n]")
req, _ := http.NewRequest("PUT", 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.put("https://api.pyai.com/v1/agents/{id}/tools")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"tool_id\": \"<string>\",\n \"enabled\": true,\n \"config\": {},\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"input_schema\": {}\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pyai.com/v1/agents/{id}/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"tool_id\": \"<string>\",\n \"enabled\": true,\n \"config\": {},\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"input_schema\": {}\n }\n]"
response = http.request(request)
puts response.read_body{
"object": "list",
"data": [
{
"tool_id": "<string>",
"enabled": true,
"config": {},
"name": "<string>",
"description": "<string>",
"input_schema": {}
}
]
}{
"error": {
"message": "<string>",
"type": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"param": "<string>"
}
}Authorizations
apiKeyxApiKey
Use Authorization: Bearer pyai_live_... (or pyai_test_...).
Path Parameters
Body
application/json
Customer SETTINGS for this tool on this agent, keyed by the tool's config_schema field keys (e.g. { from_number, provider_api_key }). Fields marked secret are encrypted at rest and returned masked ('********'); re-send the mask (or omit) to keep the stored value.
Present on agent reads when the tool resolves.
Per-call model argument schema. Present on agent reads when the tool resolves.
Resolved execution mode. Present on agent reads when the tool resolves.
Available options:
hosted, server, engine, client ⌘I