DocsAPI reference

List calls

What this tool has actually done, most recent first.

get/api/tools/{tool_id}/calls
Authentication
Bearer token
Retries
Safe to repeat
Body
None
Version
2026-09-03

failed_only is the triage path and is served by ix_tool_calls_failures, so it does not scan the successes - which are, on a working tool, nearly all of the rows.

Path parameters#

  • tool_idstring (uuid)required

Query parameters#

  • pageinteger

    Default: 1·≥ 1

  • page_sizeinteger

    Default: 20·≥ 1 and ≤ 100

  • failed_onlyboolean

    Default: false

Responses#

  • 200OKapplication/json

    PaginatedResponse_ToolInvocationResponse_

    • itemsarray of ToolInvocationResponserequired
      15 fieldsToolInvocationResponse
      • agent_idstring (uuid)required
      • argumentsobjectrequired
      • attemptsintegerrequired
      • call_idstringrequired
      • conversation_idstring (uuid) | nullrequired
      • created_atstring (date-time)required
      • duration_msintegerrequired
      • error_codestring | nullrequired
      • idstring (uuid)required
      • okbooleanrequired
      • resultstring | nullrequired
      • status_codeinteger | nullrequired
      • stepintegerrequired
      • tool_idstring (uuid) | nullrequired
      • tool_namestringrequired
    • pageintegerrequired
    • page_sizeintegerrequired
    • totalintegerrequired
    • has_moreboolean

      Default: false

    • next_cursorstring | null
    5 response headers
    RateLimit-Limit

    Requests permitted in the current window.

    RateLimit-Remaining

    Requests left in the current window. Back off before it reaches 0.

    RateLimit-Reset

    Seconds until the current window resets.

    X-API-Version

    The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.

    X-Request-ID

    Quote this in a support request to identify the call.

  • 422Validation error

    The shared error envelope, served as application/problem+json with error.code set to validation_error. Its details name each field that failed and why.

Errors#

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

  • validation_error · 422 — The payload was well-formed JSON but failed schema validation.
  • unauthenticated · 401 — The request carried no API key, or one the API could not verify.
  • forbidden · 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.
  • rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.

More Tools endpoints#

Something unclear or missing? Tell us and we’ll fix it.