curl -X POST https://api.scrapio.dev/v1/crawl \
-H "Authorization: Bearer $SCRAPIO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"seeds":["https://example.com"],"max_pages":3}'import requests
url = "https://api.scrapio.dev/v1/crawl"
payload = {
"seeds": ["https://example.com"],
"max_pages": 3
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({seeds: ['https://example.com'], max_pages: 3})
};
fetch('https://api.scrapio.dev/v1/crawl', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrapio.dev/v1/crawl",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'seeds' => [
'https://example.com'
],
'max_pages' => 3
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.scrapio.dev/v1/crawl"
payload := strings.NewReader("{\n \"seeds\": [\n \"https://example.com\"\n ],\n \"max_pages\": 3\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.scrapio.dev/v1/crawl")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"seeds\": [\n \"https://example.com\"\n ],\n \"max_pages\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrapio.dev/v1/crawl")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"seeds\": [\n \"https://example.com\"\n ],\n \"max_pages\": 3\n}"
response = http.request(request)
puts response.read_body{
"id": "b9fdf0a0-3211-446e-8959-12e2300f0c2a",
"request_id": "b9fdf0a0-3211-446e-8959-12e2300f0c2a",
"kind": "crawl",
"mode": "inline",
"status": "completed",
"steps": [
{
"step_id": "step_crawl_fetch",
"type": "crawl_fetch",
"status": "completed",
"started_at": "2026-07-17T14:27:44.998Z",
"completed_at": "2026-07-17T14:27:45.090Z"
}
],
"result": {
"seeds": [
"https://example.com"
],
"pages": [
{
"url": "https://example.com/",
"depth": 0,
"status": "completed",
"outputs": {
"markdown": "# Example Domain\n\nExample Domain\n\nExample DomainThis domain is for use in documentation examples without needing permission. Avoid use in operations.Learn more"
}
}
],
"summary": {
"pages_discovered": 1,
"pages_fetched": 1,
"pages_succeeded": 1,
"pages_failed": 0,
"pages_skipped": 1
}
},
"diagnostics": {
"step_errors": []
}
}{
"request_id": "<string>",
"error": {
"code": "<string>",
"message": "<string>"
},
"diagnostics": {
"outcome": "failed",
"retryable": true,
"blocked": true,
"timed_out": true
}
}{
"request_id": "<string>",
"error": {
"code": "<string>",
"message": "<string>"
},
"diagnostics": {
"outcome": "failed",
"retryable": true,
"blocked": true,
"timed_out": true
}
}{
"request_id": "<string>",
"error": {
"code": "<string>",
"message": "<string>"
},
"diagnostics": {
"outcome": "failed",
"retryable": true,
"blocked": true,
"timed_out": true
}
}Crawl
Crawl a site starting from one or more seed URLs, following links up to a configurable depth.
curl -X POST https://api.scrapio.dev/v1/crawl \
-H "Authorization: Bearer $SCRAPIO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"seeds":["https://example.com"],"max_pages":3}'import requests
url = "https://api.scrapio.dev/v1/crawl"
payload = {
"seeds": ["https://example.com"],
"max_pages": 3
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({seeds: ['https://example.com'], max_pages: 3})
};
fetch('https://api.scrapio.dev/v1/crawl', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrapio.dev/v1/crawl",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'seeds' => [
'https://example.com'
],
'max_pages' => 3
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.scrapio.dev/v1/crawl"
payload := strings.NewReader("{\n \"seeds\": [\n \"https://example.com\"\n ],\n \"max_pages\": 3\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.scrapio.dev/v1/crawl")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"seeds\": [\n \"https://example.com\"\n ],\n \"max_pages\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrapio.dev/v1/crawl")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"seeds\": [\n \"https://example.com\"\n ],\n \"max_pages\": 3\n}"
response = http.request(request)
puts response.read_body{
"id": "b9fdf0a0-3211-446e-8959-12e2300f0c2a",
"request_id": "b9fdf0a0-3211-446e-8959-12e2300f0c2a",
"kind": "crawl",
"mode": "inline",
"status": "completed",
"steps": [
{
"step_id": "step_crawl_fetch",
"type": "crawl_fetch",
"status": "completed",
"started_at": "2026-07-17T14:27:44.998Z",
"completed_at": "2026-07-17T14:27:45.090Z"
}
],
"result": {
"seeds": [
"https://example.com"
],
"pages": [
{
"url": "https://example.com/",
"depth": 0,
"status": "completed",
"outputs": {
"markdown": "# Example Domain\n\nExample Domain\n\nExample DomainThis domain is for use in documentation examples without needing permission. Avoid use in operations.Learn more"
}
}
],
"summary": {
"pages_discovered": 1,
"pages_fetched": 1,
"pages_succeeded": 1,
"pages_failed": 0,
"pages_skipped": 1
}
},
"diagnostics": {
"step_errors": []
}
}{
"request_id": "<string>",
"error": {
"code": "<string>",
"message": "<string>"
},
"diagnostics": {
"outcome": "failed",
"retryable": true,
"blocked": true,
"timed_out": true
}
}{
"request_id": "<string>",
"error": {
"code": "<string>",
"message": "<string>"
},
"diagnostics": {
"outcome": "failed",
"retryable": true,
"blocked": true,
"timed_out": true
}
}{
"request_id": "<string>",
"error": {
"code": "<string>",
"message": "<string>"
},
"diagnostics": {
"outcome": "failed",
"retryable": true,
"blocked": true,
"timed_out": true
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Starting URLs to crawl from
1Cap on total pages crawled
x <= 200Max link depth from seeds
0 <= x <= 5Restrict crawl to seed domains
Output formats per page (default ["markdown"])
1html, markdown, json Structured extraction config, requires json output
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Max crawl duration, in ms
x <= 300000Proxy and escalation mode. "basic": no proxy at all (cheapest; if the target blocks it the request fails and tells you to use "auto"). "stealth": go straight to the strongest tier, a hardened browser behind a residential proxy (paid plans). "auto": try cheap steps first and escalate to a residential proxy only when needed, billed by the step that served the request (paid plans, the default). The Free plan is always "basic".
basic, stealth, auto Deprecated: use proxy: "stealth". Go straight to the strongest access tier for every page crawled. Requires a paid plan.
Response
Crawl completed inline.
Common envelope every workflow endpoint (crawl, map, interact, search) returns: request/step metadata plus a kind-specific result.
crawl, map, interact, search inline completed, partial, failed Kind-specific payload -- see the endpoint's example.