Skip to main content
GET
Get tool schema

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

slug
string
required

The tool's slug. Nested slugs keep their slash: ai-writer/story.

Response

The tool's contract.

slug
string
required

The tool's identifier — use it in GET /v1/tool/{slug} and POST /v1/tool/{slug}.

title
string
required

Human-readable tool name.

description
string
required

One-line summary of what the tool does.

category
string
required

One of the six catalog categories, e.g. converters.

credit_cost
integer
required

Credits a run of this tool costs YOUR key, floor included — so it already reflects your plan and can be compared directly against GET /v1/me/credits.

schema
object
required
credit_cost_multiplier_field
string

Present only on per-unit tools: credit_cost is then a rate, and a run costs it times the value of this input field.

examples
object[]

Worked examples, omitted when the tool declares none. expected is present only for deterministic tools — AI/random output has no fixed answer to print.