Purrkey
Get started
Documentation
Browse api reference

HTTP API overview

Build the discover → inspect → run → retrieve flow into your own application.

View as Markdown
On this page

Connection and authentication

Send an API key in the Authorization header. JSON request bodies use Content-Type: application/json. Account management remains in the signed-in console; a tool API key is not a website session.

API origin
https://api.purrkey.app
First API callFollow an end-to-end request using curl.

Shared conventions

ConventionRule
MoneyDecimal integer strings in micro-units. 1000000 = 1 USD for account balance.
DatesUTC RFC3339 timestamps.
PaginationOpaque cursor and bounded limit; nextCursor is null on the last page.
Tool inputsUse the selected tool's inspect inputSchema; it is not a platform-wide input shape.
RetriesPreserve the original idempotency key and effective request after uncertain submission.
ResultsCheck result.status and billing independently from HTTP and execution status.

Tool API endpoints

List toolsGET /v1/toolsDiscover toolsPOST /v1/discoverInspect a toolPOST /v1/inspectCreate a RunPOST /v1/runsList RunsGET /v1/runsRetrieve a RunGET /v1/runs/{runId}Cancel a RunPOST /v1/runs/{runId}/cancelRead your balanceGET /v1/balance

OpenAPI contract

These reference fields are generated from HTTP contract 0.4.3. The download includes nested schemas and additional account and payment endpoints; those endpoints have their own authentication and deployment requirements.

Download OpenAPIUse the YAML contract in your API tooling.