VocalDocscontracts 1.65.0

List Tools

GET /v1/tools

PropertyValue
Operationlist_tools
GroupTools
Scopetools:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read; a Tool is not Call content and its auth secret is never returned.
Released in1.49.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Lists the Tools, newest first, with an optional filter by type; archived Tools are listed only with archived=true.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the tools:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/tools" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
typequeryToolTypenoOnly the Tools of this type.
archivedqueryone of "true", "false"notrue lists only archived Tools; false, the default, only the others.

Responses

StatusContent typeShapeError codes
200application/jsonToolList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is ToolList.

FieldTypeRequiredDescription
dataarray of ToolyesThe Tools of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes