Documentation

List tools

Browse the published tools accessible to the current credential.

View as Markdown
On this page

Endpoint

Follow nextCursor with the same providerId, category, account and tool access. You can change limit between pages. A null nextCursor marks the last page.

If the API returns 422 invalid_cursor, omit cursor and start from the first page. Inspect a tool before using its inputs or price.

HTTP
GET /v1/tools

Parameters

NameLocationTypeRequiredConstraints
cursorquerystringOptional—
limitqueryintegerOptionalMinimum: 1; Maximum: 100; Default: 20
providerIdquerystringOptional—
categoryquerystringOptional—

Request example

Set PURRKEY_API_KEY in your trusted server or terminal environment. Replace any angle-bracket placeholders with values from your own inspection or Run.

Bash
curl --fail-with-body --request GET 'https://api.purrkey.app/v1/tools' \
  -H "Authorization: Bearer $PURRKEY_API_KEY"

Successful response

Success HTTP status: 200. Top-level response fields are listed below. Conditional and nested requirements are defined in the downloadable OpenAPI contract.

FieldTypeRequiredConstraints
itemsobject[]Required—
nextCursorstring | nullRequired—
catalogVersionstringRequired—

Errors and related reading