Developers

Build on PyroSync

Everything here is generated from the platform OpenAPI spec and the API's own guide renderers, so it matches what the API does. 52 operations live under /api/v1.

Quick start

Create an API key in Settings, then send it as X-API-Key. Responses use { success, data }, errors use { success: false, error }, and every response carries rate-limit headers.

curl -X POST "$PYROSYNC_URL/api/v1/scrape" \
  -H "X-API-Key: $PYROSYNC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com"}'

The raw spec is at /platform-openapi.json.

API reference

Every /api/v1 operation, generated from the platform OpenAPI spec.

SDKs

TypeScript, Python, Go, Rust, and Java clients.

Quickstarts

Eight copy-paste walkthroughs, from scraping a page to triggering a workflow.

Guides

Build with PyroSync (which surface to use when), errors, lists and pagination, request signing, and versioning.

Changelog

Additions, changes, and deprecations with sunset dates.

Status

Live health of this deployment.

Console

Call the API against your own workspace, with cost warnings on billable calls.