v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
Tools

Get tool

Returns the full details of a tool, including its description, input schema, metadata, and capabilities. Tools may represent structured search functions, document-processing workflows, or user-defined Lambda functions. Some tools work with artifacts stored in a session. Others operate on structured inputs defined by their JSON schema.

get/v2/tools/{tool_id}

Path parameters

tool_idstring required
Example:tol_rag_search

The unique identifier of the tool.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

The requested tool details.

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "id": "tol_123e4567-e89b-12d3-a456-426614174000",
  "default_output_transform": ".results | map({title, url})",
  "default_input_transform": ".args + { auth: (\"Bearer \" + .agent.secrets.token) }",
  "default_argument_override": {
    "max_results": 10
  },
  "lineage": "corpora_search",
  "version": "2026-02-23",
  "tool_groups": [
    "document_ingestion"
  ],
  "type": "dynamic_vectara"
}