REST API · single mode
Single-page crawl
Crawl exactly one URL — no link discovery, no recursion. The fastest path through Syttra: one request in, one document out. One page counted against your monthly quota.
When to use it
- You know the exact URL you want and only that URL.
- Quick lookups: a product page, a news article, a single docs page.
- Recurring checks of one page (paired with the upcoming page-watcher feature).
- You're piping the result straight into an LLM and don't want BFS noise.
For multi-URL needs, see full (BFS discovery) or select (explicit URL list).
Create a single-page job
POST
/v1/jobs202 AcceptedSubmits one URL. Returns immediately with a job ID — the crawl runs asynchronously on our workers.
Request body
| Parameter | Type | Default |
|---|---|---|
url* The URL to scrape. Must be a public HTTPS URL. Internal / RFC1918 IPs are blocked. | string (URL) | required |
mode* Set to "single" for this guide. | string enum | required |
export_formats Output formats. Currently: markdown, text. HTML, PDF, Word in v1.1. | array of strings | ["markdown"] |
respect_robots Check robots.txt before crawling. Disabling is only allowed with an Enterprise agreement. | boolean | true |
check_tos Inspect the target site's ToS for anti-scraping clauses. Jobs fail with tos_blocked if detected. | boolean | true |
max_depth, max_pages, concurrency and urls are not used in single mode and will be rejected with 422 validation_error if present.
Example request
POST /v1/jobs
curl https://api.syttra.com/v1/jobs \
-H "Authorization: Bearer sk_live_..." \
-H "Content-Type: application/json" \
-d '{
"url": "https://en.wikipedia.org/wiki/White_House",
"mode": "single",
"export_formats": ["markdown"]
}'Example response
202 Accepted
{
"id": "9a47f5c1-8e6d-4b8f-a6e9-1f2b3c4d5e6f",
"status": "queued",
"url": "https://en.wikipedia.org/wiki/White_House",
"mode": "single",
"links": {
"self": "/v1/jobs/9a47f5c1-...",
"result": "/v1/jobs/9a47f5c1-.../result"
}
}What's next
Polling, downloading the result, and error handling are documented in the REST API overview. Quick links:
- GET /v1/jobs/{id} — poll until
completed - GET /v1/jobs/{id}/result — download the markdown
- Error envelope