Skip to main content
GET
Get Tool

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tool_id
string
required

Response

Request fulfilled, document follows

tool_id
string
required
workspace_id
string
required
name
string
required
tool_type
enum<string>
required
Available options:
webhook,
client
method
enum<string>
required
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
url
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
parameters
Parameters · object
required

Call parameters as a JSON Schema object (draft 2020-12): type: object (filled in when omitted), properties, required. Standard meaning throughout: required means the key must be present, type: ["string", "null"] allows null, minLength: 1 makes a string non-empty, enum and pattern constrain the value, default fills a key the model left out. Mutually exclusive with arguments in one request. A tool created with parameters starts in parameter_mode: strict.

content_type
string
required
timeout_seconds
integer
required
error_handling
enum<string>
required
Available options:
passthrough,
hide
description
string
default:""
used_by
integer
default:0

How many agents reference this tool in their draft configuration.

arguments
AgentWebhookArgumentPayload · object[]

Older shape of parameters: each entry becomes a required string parameter. Mutually exclusive with parameters in one request. Reads return both, arguments being the string parameters of the schema.

parameter_mode
enum<string>
default:legacy

Whether the agent runtime checks each call's arguments against parameters before running the tool. legacy (the default for tools created with arguments, and every tool from before this field existed): no check, the model's arguments run as sent. strict (the default for tools created with parameters): a call that does not satisfy the schema is refused and the model is told to ask the caller for the missing information, and the LLM provider's constrained decoding is turned on where the model supports it (OpenAI models and a custom OpenAI-compatible endpoint receive the tool with strict: true, Gemini on the platform's native channel runs validated function calling). Changing parameters never changes the mode, and the mode can be changed on its own.

Available options:
legacy,
strict
body_template
string
default:""
headers
PublicToolHeader · object[]
mock_responses
AgentWebhookMockResponsePayload · object[]
expects_response
boolean
default:true
execution_mode
enum<string>
default:blocking
Available options:
blocking,
fire_and_forget,
background