Agents

OpenAPI 3.1

Use Crawly’s machine-readable API contract with REST clients, code generators, and GPT Actions.

Specification URL

Crawly publishes a live OpenAPI 3.1 document generated from the same endpoint and policy definitions used by the application.

https://app.crawly.cc/openapi.json

What it covers

Bearer API-key authentication
Scrape, Search, Map, Crawl, Batch, Jobs, Extract, Interact, Monitors, and Credits
Request schemas, path parameters, response codes, and current credit notes
Production server origin at app.crawly.cc

Use the raw JSON

Copy the specification URL into Postman, an OpenAPI code generator, or the ChatGPT GPT Actions importer. Browsers can still open the raw JSON endpoint directly when you need the machine-readable document.

Note: The documentation page stays inside the Crawly Docs shell; /openapi.json remains the canonical raw contract for tools.