Peel is currently in private preview. Public signup is disabled on
peel.sh, so use an existing account and API key from https://peel.sh/settings.Start here
Quickstart
Build, inspect, and call your first compiled API.
CLI
Set up the hosted CLI, auth flow, and MCP install path.
How it works
See the build-time agent and deterministic runtime model.
Authentication
API keys and OAuth for REST and MCP clients.
Core concepts
APIs, endpoints, matching, and sessions.
Core operations
The public API surface centers on build, runtime, lifecycle, diagnostics, and export operations:| Operation | Route | Use it when |
|---|---|---|
| Build | POST /v1/apis | Compile an API from a URL and task. See Quickstart. |
| Inspect | GET /v1/apis/{api_id} | Read the current lifecycle state, endpoint list, schemas, auth mode, and links. |
| Execute | POST /v1/apis/{api_id}/endpoints/{endpoint_name}:call | Run a published endpoint. See Call an endpoint. |
| Revise | POST /v1/apis/{api_id}/revise | Keep the site, change the build intent. See API updates. |
| Rebuild | POST /v1/apis/{api_id}/rebuild | Keep the instructions, refresh the compiled evidence. |
| Respond | POST /v1/apis/{api_id}/respond | Continue a build that paused in needs_input. |
| Health | GET /v1/apis/{api_id}/health | Check build-stage diagnostics, failure artifacts, or published endpoint health. |
| Export | GET /v1/apis/{api_id}/exports/openapi and GET /v1/apis/{api_id}/exports/mcp | Download the API as OpenAPI or MCP. See Exporting an API. |
api.id, so callers and generated clients do not need to migrate after updates.
Base URL
https://api.peel.sh/mcp. Every build returns an api.id, which is the stable handle for later operations. If you call POST /v1/apis with a URL that already has a compatible build, Peel reuses it (matched: true). Pass force_new: true to compile a fresh one.
The CLI defaults to the same API host for programmatic calls and opens browser auth on https://peel.sh when needed. See CLI.