Terms
Build input
A build starts fromPOST /v1/apis with a public url and optional instructions (up to 2000 characters). If a compatible API already exists for that URL, Peel returns it with matched: true and charges nothing. Send force_new: true to build a new one.
Build lifecycle
api.status is one of four values:
The build compiler investigates the site, writes the program, runs every declared example against the exact program, and sends it to review. A change to the program invalidates its verification, so only an exact, tested program is published. How it works covers each stage.
Endpoints
Each published endpoint carries a contract. Treat it as the source of truth for payloads.
Calls run at
POST /v1/apis/{api_id}/endpoints/{endpoint_name}:call regardless of the endpoint’s method, which records how the program reaches the site.
Pagination
An endpoint that pages through results takes a cursor in itsinput_schema and returns the next one in its output. Cursors are signed and bound to your account, the API version, the endpoint, its inputs and an expiry. A cursor used with a different filter, from another account or after it expires is rejected before any request reaches the site.
Versions and updates
- Revise (
POST /v1/apis/{api_id}/revise) keeps the site and changes the instructions. Counts as one build; not counted if the revision fails. - Rebuild (
POST /v1/apis/{api_id}/rebuild) keeps the instructions and recompiles from fresh evidence. Counts as one build; not counted if the rebuild fails. - Published versions never change underneath you. A site change that breaks calls shows up in health and diagnostics, and a rebuild publishes a new version.
GET /v1/apis/{api_id}/revisionslists the revision history.
409 with api_rebuild_required. Rebuild them; Peel never reinterprets them silently.