Tools
CreateToolResponse
Bases: BaseModel
Response data for tool creation and retrieval operations.
This response contains complete information about a tool including its configuration, credentials, parameters, and metadata.
Attributes:
| Name | Type | Description |
|---|---|---|
id |
str
|
Unique identifier for the tool |
created_at |
datetime
|
Timestamp when the tool was created |
updated_at |
datetime
|
Timestamp when the tool was last updated |
tool_type |
str
|
Type of the tool (e.g., "custom") |
name |
str
|
Name of the tool |
standardized_name |
str
|
Standardized version of the tool name |
display_name |
Optional[str]
|
Display name of the tool (includes provider suffix for gateway tools) |
origin |
Optional[str]
|
Origin of the tool |
description |
str
|
Brief description of what the tool does |
method_type |
str
|
HTTP method type (Get, Post, Put, Delete) |
purpose |
str
|
When and why to use this tool |
api_endpoint |
str
|
Web API endpoint where the tool sends requests |
provider |
str
|
Provider of the tool |
tool_credentials |
ToolCredentials
|
Credentials configuration for the tool |
headers |
List[ToolHeader]
|
Headers required when making API requests |
body |
str
|
Body of the request that the tool sends to the API |
body_type |
str
|
Type of the request body (Json, XFormUrlEncoded, None) |
parameters |
List[ToolParameter]
|
List of parameters the tool accepts |
project_id |
Optional[str]
|
ID of the project this tool belongs to |
project_name |
Optional[str]
|
Name of the project this tool belongs to |
project |
Optional[ProjectReference]
|
Project reference object |
children |
Optional[List[CreateToolResponse]]
|
Child tool definitions |
route_through_acc |
bool
|
Whether the tool should route through an ACC specific group |
should_redirect |
bool
|
Whether the tool should redirect |
acc_group |
Optional[str]
|
ACC specific group name |
documentation |
Optional[str]
|
Documentation for the tool |
tags |
Optional[List[str]]
|
List of tags associated with the tool |
tool_metadata |
Optional[List[ToolMetadata]]
|
List of metadata key-value pairs |
supports_pagination |
Optional[bool]
|
Whether the tool supports pagination |
category |
str
|
Category of the tool (Action, Airia, Mcp) |
request_timeout |
int
|
Request timeout in seconds |
ToolHeader
Bases: BaseModel
Key-value pair header for a tool definition.
Attributes:
| Name | Type | Description |
|---|---|---|
key |
str
|
The key of the header |
value |
str
|
The value of the header |
ToolParameter
Bases: BaseModel
Parameter definition for a tool.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
Name of the parameter |
type |
str
|
Type of the parameter |
description |
str
|
Description of what the parameter does |
default |
Optional[str]
|
Default value for the parameter |
valid_options |
Optional[List[str]]
|
List of valid options for the parameter |
array_item_type |
Optional[str]
|
Type of items if this parameter is an array |
parameters |
Optional[List[ToolParameter]]
|
Nested parameters for complex types |
requirement |
str
|
Whether the parameter is required or optional |