Connect to Paperplane
The public Paperplane website is a browser client. Your own Paperplane environment runs the backend and coding providers. Documentation endpoints on this origin are public and read-only; they cannot start turns, access files, or authenticate a provider.
Install and start your host
Install the Paperplane desktop app or CLI using the installation guide. Authenticate at least one supported provider on that computer. For a persistent CLI host, run `paperplane service install --host 127.0.0.1 --port 3773`, then check it with `paperplane service status`. Keep pairing authentication enabled. Do not publish someone else's pairing code or expose their host.
Pair the browser app
Make your host reachable through a trusted HTTPS endpoint, such as a private Tailscale endpoint or your own Cloudflare Tunnel. Create a one-time code with `paperplane auth pairing create`. In the browser app, open Settings → Connections, add the environment's HTTPS address, and enter that code. A plain HTTP LAN address cannot be used from the public HTTPS app. Keep the host and any tunnel running while you work.
Discover public content
Request `/` or `/docs` with `Accept: text/markdown` for Markdown, or `Accept: text/html` for HTML. Both representations set `Vary: Accept`. Direct Markdown files are available at `/index.md` and `/docs.md`. `/openapi.json` documents these public resources, and `/schema/paperplane.json` is the JSON Schema for a project's paperplane.json configuration. Unknown resources return HTTP 404. Unsupported methods return 405 with an Allow header. Unsupported representations return 406.
Understand the API boundary
There is no public agent execution API on this hosted origin. Requests to `/api` and its subpaths return JSON errors with a code, message, resolution hint, and documentation link. Pair your own environment to use the workspace. Its authenticated WebSocket protocol is separate from the read-only OpenAPI document on this site.