Skip to main content
POST
/
v1
/
tools
/
{id}
Update a tool
curl --request POST \
  --url https://api.pyai.com/v1/tools/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "input_schema": {},
  "webhook_url": "<string>",
  "timeout_ms": 7550
}
'
{
  "object": "tool",
  "id": "<string>",
  "org_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "input_schema": {},
  "webhook_url": "<string>",
  "timeout_ms": 123,
  "created_at": 123
}

Authorizations

Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Path Parameters

id
string
required

Body

application/json
name
string
description
string
input_schema
object
webhook_url
string<uri> | null
side_effect
enum<string>
Available options:
read,
action
timeout_ms
integer
Required range: 100 <= x <= 15000
status
enum<string>
Available options:
active,
disabled

Response

Updated tool

object
string
Example:

"tool"

id
string
org_id
string | null
name
string
kind
enum<string>
Available options:
prebuilt,
custom
description
string
input_schema
object
webhook_url
string | null
side_effect
enum<string>
Available options:
read,
action
timeout_ms
integer
status
enum<string>
Available options:
active,
disabled
created_at
integer