Outway documentation
Quickstart
Make your first Outway API request and retrieve the resulting capture and artifacts.
Before you begin
Create an account, verify your email, and start from Overview. New Free enrollment creates your first project. Choose Inspect a website to try the Playground, or Use Outway with my AI for guided setup. For a direct API integration, create an API key with access to that project and capture creation. Copy the project ID. Keep the token in your local environment or secret manager; never commit it.
The examples use OUTWAY_TOKEN and OUTWAY_PROJECT_ID environment variables. Replace placeholders locally, not in a shared chat.
Submit a page
curl --fail-with-body https://api.outway.dev/v1/projects/$OUTWAY_PROJECT_ID/scrapes \
-H "Authorization: Bearer $OUTWAY_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"url":"https://example.com"}'
This starts an asynchronous job. Save the returned job ID; acceptance does not mean the page has finished collecting.
Wait for completion
Set JOB_ID to the returned ID, then poll with a short delay between requests:
curl --fail-with-body https://api.outway.dev/v1/jobs/$JOB_ID \
-H "Authorization: Bearer $OUTWAY_TOKEN"
Keep polling while the job is queued, running or waiting for retry. Handle terminal failures and budget blocks explicitly. On success, use the capture ID returned by the job.
Read the evidence
curl --fail-with-body https://api.outway.dev/v1/captures/$CAPTURE_ID/artifacts \
-H "Authorization: Bearer $OUTWAY_TOKEN"
Use an artifact ID from that response with /v1/captures/{captureId}/artifacts/{artifactId}/content. Check the listed media type before decoding content.
Run the complete example
Download the first-capture TypeScript example. It submits, polls, downloads and verifies artifact hashes. Run it with Node.js 24 and the same environment variables.