API ReferenceToolsTool definitions

List Tool Attached Agents

Beta

List the agents in the caller’s workspace that currently have this tool attached. Useful before deleting a tool, to surface which agents will lose access. Soft-deleted agents are filtered out. Cursor-paginated: omit cursor for the first page; walk pages while has_more is true (default page size 50, max 200).

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

tool_definition_idstringRequired

Tool definition id (prefixed external id, tool_...).

Headers

Speechify-VersionstringOptional

Query parameters

cursorstringOptional
Opaque pagination cursor from a previous response.
limitintegerOptional1-200Defaults to 50

Max items per page (default 50, max 200).

Response headers

X-Request-IDstring
Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an `X-Request-ID` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope.

Response

Agents in the caller's workspace attached to the tool.
next_cursorstring or null

Opaque keyset cursor for the next page. Pass back as the cursor request parameter. null when the caller has reached the end of the list (has_more is also false in that case).

has_moreboolean
True when more rows exist beyond this page.
agentslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error