Outway documentation
API reference
Browse Outway API entry points and download the versioned OpenAPI specification.
Base URL and contract
The production base URL is https://api.outway.dev. Authenticate with a Bearer token. Use Outway’s own schemas rather than a Firecrawl SDK or request format.
Download OpenAPI YAML · Contract source revision · Complete developer guide
The downloadable contract is a committed snapshot. Its source revision identifies the implementation it documents; deployment availability may differ.
Collection endpoints
| Method | Path | Purpose |
|---|---|---|
| POST | /v1/projects/{projectId}/scrapes | Submit a page |
| POST | /v1/projects/{projectId}/crawls | Start a bounded crawl |
| POST | /v1/projects/{projectId}/maps | Discover URLs |
| POST | /v1/projects/{projectId}/batches | Submit a URL list |
| GET | /v1/jobs/{jobId} | Inspect asynchronous progress |
| GET | /v1/captures/{captureId} | Read capture metadata |
| GET | /v1/captures/{captureId}/artifacts | List saved evidence |
| GET | /v1/captures/{captureId}/artifacts/{artifactId}/content | Download an artifact |
Workspace endpoints
| Method | Path | Purpose |
|---|---|---|
| GET | /v1/key-access | Inspect effective credential access |
| GET | /v1/projects | List accessible projects |
| GET | /v1/billing/subscription | Read recorded subscription state |
| GET | /v1/billing/catalog | Read the launch reference catalog |
| GET | /v1/billing/plans | Read configured checkout plans |
For request schemas, optional fields, security requirements and additional search, extraction, schedule and administrative endpoints, consult the full OpenAPI document.
Start with a working example
Follow the quickstart or download the first-capture example. Never paste a production token into a public documentation playground.