List a custom API tool's runs
GET/v1/agents/:agentId/custom-api-tools/:toolId/runs
x-scope: "custom_api:read"
The times the AI used the tool, newest first: how each went, how long it took and the conversation. Never what was sent or received.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
- 500
- 503
A page of runs.
Response Headers
Correlation id for this request — paste into support tickets.
Authentication failed. Single code (invalid_api_key) covers every
sub-case: missing header, wrong scheme, malformed, unknown, revoked or
expired key. The message field disambiguates for humans debugging.
One exception: when the key could not be checked because of a server-side
fault, the status is still 401 but type is internal_error and code
is internal_server_error; retry with backoff.
Response Headers
Correlation id for this request — paste into support tickets.
Authenticated, but not allowed. insufficient_scope (the key lacks
custom_api:read or custom_api:write), agent_not_authorized (the
key is limited to other agents) or feature_not_available (Custom API
isn't on your company's plan).
Response Headers
Correlation id for this request — paste into support tickets.
agent_not_found when the agent is not one of your company's agents
(the API never confirms whether another company's agent exists);
not_found when the tool is not one of this agent's custom API tools;
endpoint_not_found for a path or method no endpoint serves, including
an id that is not a UUID.
Response Headers
Correlation id for this request — paste into support tickets.
invalid_request_body when the body isn't valid JSON for the operation, a
field has the wrong type, or a field breaks a limit in its schema (a
query parameter that doesn't parse, on listCustomApiToolRuns).
invalid_request when the tool breaks one of the rules the dashboard
checks too (its link, inputs, headers, body or login), or the cursor
isn't one this list gave out. param names the field when there is one,
and the message says what to change.
Response Headers
Correlation id for this request — paste into support tickets.
Per-key rate limit hit. Default is 60/min/key; an endpoint with an
x-rate-limit-per-minute of its own counts in a budget of its own
(today listWhatsAppTemplates, which allows 10/min/key, and
sendConversationMessage, which allows 20/min/key), and its 429
reports that limit in X-RateLimit-Limit. Retry-After tells you when to retry;
X-RateLimit-Reset is the Unix timestamp of the next window.
Per-success-response
X-RateLimit-*headers are a known gap; on 2xx responses these headers are NOT currently emitted. Customers should rely on 429 +Retry-Afterfor backoff signals.
Response Headers
Correlation id for this request — paste into support tickets.
Seconds to wait before retrying.
The per-minute request limit of the endpoint called. Every key has the same limits today.
Remaining requests in the current window. 0 on rejection.
Unix timestamp at which the current window resets.
Unexpected server-side failure. Retry with exponential backoff. If
the failure persists, send us the correlation_id.
Response Headers
Correlation id for this request — paste into support tickets.
Mojeeb couldn't check access because of a temporary fault: the key's,
or on assignLead and assignConversation the teammate's. Nothing was
changed. Retry with backoff.
Response Headers
Correlation id for this request — paste into support tickets.