Skip to main content
GET
/
v1
/
tools
/
{id}
Get a tool
curl --request GET \
  --url https://api.pyai.com/v1/tools/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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

Response

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