agentsTools

List Agent Tools

Get tools from an existing agent

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Path parameters

agent_idstringRequiredformat: "^agent-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"=42 characters

The ID of the agent in the format ‘agent-<uuid4>’

Query parameters

beforestring or nullOptional
Tool ID cursor for pagination. Returns tools that come before this tool ID in the specified sort order
afterstring or nullOptional
Tool ID cursor for pagination. Returns tools that come after this tool ID in the specified sort order
limitinteger or nullOptionalDefaults to 10
Maximum number of tools to return
orderenumOptionalDefaults to desc
Sort order for tools by creation time. 'asc' for oldest first, 'desc' for newest first
Allowed values:
order_by"created_at"Optional
Field to sort by

Response

Successful Response
idstring or nullformat: "^tool-[a-fA-F0-9]{8}"

The human-friendly ID of the Tool

tool_typeenum or null
The type of the tool.
descriptionstring or null
The description of the tool.
source_typestring or null
The type of the source code.
namestring or null
The name of the function.
tagslist of strings or null
Metadata tags.
source_codestring or null
The source code of the function.
json_schemamap from strings to any or null
The JSON schema of the function.
args_json_schemamap from strings to any or null
The args JSON schema of the function.
return_char_limitinteger or nullDefaults to 50000
The maximum number of characters in the response.
pip_requirementslist of objects or null
Optional list of pip packages required by this tool.
npm_requirementslist of objects or null
Optional list of npm packages required by this tool.
default_requires_approvalboolean or null
Default value for whether or not executing this tool requires approval.
enable_parallel_executionboolean or nullDefaults to false
If set to True, then this tool will potentially be executed concurrently with other tools. Default False.
created_by_idstring or null
The id of the user that made this Tool.
last_updated_by_idstring or null
The id of the user that made this Tool.
metadata_map from strings to any or null
A dictionary of additional metadata for the tool.

Errors