v63

latestOpenAPI 3.0.0Proprietaryraw.githubusercontent.com2026-08-0110571.8 MB
Tool Router

Search for tools using a query

Search for tools matching a use case query within an existing tool router session.

post/api/v3.1/tool_router/session/{session_id}/search

Path parameters

session_idstring toolRouterSessionId required

Tool router session ID (trs_*)

Example:trs_LX9uJKBinWWr

Tool router session ID (trs_*)

Request body

modelstring

Optional model hint for search/planning behavior (e.g., "gpt-4o").

Example request

{
  "queries": [
    {
      "use_case": "Send a slack message to a channel"
    }
  ],
  "model": "gpt-4o",
  "experimental": {
    "custom_toolkits": [
      {
        "slug": "ecommerce",
        "name": "E-Commerce API",
        "description": "Internal e-commerce API for order management and fulfillment",
        "tools": [
          {
            "slug": "GET_CUSTOMER_ORDERS",
            "name": "Get Customer Orders",
            "description": "Fetch recent orders for a customer by their email address",
            "input_schema": {
              "type": "object",
              "properties": {
                "email": {
                  "type": "string",
                  "description": "Customer email"
                }
              },
              "required": [
                "email"
              ]
            }
          }
        ]
      }
    ],
    "custom_tools": [
      {
        "slug": "GET_IMPORTANT_EMAILS",
        "name": "Get Important Emails",
        "description": "Fetch emails marked as important from the last 24 hours",
        "input_schema": {
          "type": "object",
          "properties": {
            "limit": {
              "type": "number",
              "description": "Max results to return"
            }
          }
        },
        "extends_toolkit": "gmail"
      }
    ]
  }
}

Response

Successfully executed the search. Returns matching tool slugs, schemas, connection statuses, and guidance.

successboolean required

Whether all searches completed successfully. False if any query failed.

errorstring nullable required

Error message if any searches failed, null if all succeeded. Format: "X out of Y searches failed, reasons: <details>"

tool_schemasobject required

Deduplicated tool definitions keyed by tool_slug for O(1) lookup. Each tool appears once even if used in multiple queries.

next_steps_guidancestring[] required

Combined workflow guidance covering connections, planner, and memory usage. Each element is a step instruction.