Skip to content
Pageteer
Docs menu

Reference

OpenAPI spec

The API publishes an OpenAPI 3.1 document generated from the same schemas that validate your requests, so it always matches the deployed API.

Where

URL
https://api.104-236-84-15.sslip.io/openapi.json

No API key is needed to read it. It describes every /v1 endpoint, its parameters with types, defaults and limits, the response bodies, the error responses and both ways to authenticate (bearer header, or api_key on GET).

curl
curl -s https://api.104-236-84-15.sslip.io/openapi.json -o pageful-openapi.json

Use it

  • TypeScript types: npx openapi-typescript https://api.104-236-84-15.sslip.io/openapi.json -o pageful.d.ts. Or use the JavaScript client, which is typed already.
  • Other languages: feed it to OpenAPI Generator or your language's generator of choice.
  • API tools: import the URL into Postman, Insomnia, Bruno or Hoppscotch and set the bearer token to your key.
  • AI coding agents: point the agent at the URL (or the downloaded file) together with these docs; the schema names every field and limit.

What the docs add

The spec is precise about shapes; these pages explain behavior it cannot express: what is charged (Credits), when to retry (Errors), job polling and pagination (Async jobs), webhook signatures (Webhooks) and the response headers (Authentication & headers). Allow unknown fields when you validate responses.

Responses may gain new fields over time; requests never accept unknown ones (they are a 400 invalid_request).