cURL
# Get all executions
curl -X GET "https://api.getcatalog.ai/v1/crawl" \
-H "x-api-key: $CATALOG_API_KEY"
# Get only completed executions
curl -X GET "https://api.getcatalog.ai/v1/crawl?status=completed" \
-H "x-api-key: $CATALOG_API_KEY"
# Get first 50 executions
curl -X GET "https://api.getcatalog.ai/v1/crawl?limit=50" \
-H "x-api-key: $CATALOG_API_KEY"
// Get all executions
const response = await fetch('https://api.getcatalog.ai/v1/crawl', {
headers: {
'x-api-key': 'YOUR_API_KEY'
}
});
const data = await response.json();
console.log(`Found ${data.executions.length} executions`);
import requests
# Get all executions
response = requests.get(
'https://api.getcatalog.ai/v1/crawl',
headers={'x-api-key': 'YOUR_API_KEY'}
)
data = response.json()
print(f"Found {len(data['executions'])} executions")
{
"executions": [
{
"execution_id": "crawl-skims-com-9b68e2c1",
"status": "processing",
"created_at": "2026-01-09T23:05:29.401291+00:00"
}
]
}
Crawl
List Crawls
List all crawls with status. Shows all crawl jobs, their current status, and when they were created.
GET
/
v1
/
crawl
cURL
# Get all executions
curl -X GET "https://api.getcatalog.ai/v1/crawl" \
-H "x-api-key: $CATALOG_API_KEY"
# Get only completed executions
curl -X GET "https://api.getcatalog.ai/v1/crawl?status=completed" \
-H "x-api-key: $CATALOG_API_KEY"
# Get first 50 executions
curl -X GET "https://api.getcatalog.ai/v1/crawl?limit=50" \
-H "x-api-key: $CATALOG_API_KEY"
// Get all executions
const response = await fetch('https://api.getcatalog.ai/v1/crawl', {
headers: {
'x-api-key': 'YOUR_API_KEY'
}
});
const data = await response.json();
console.log(`Found ${data.executions.length} executions`);
import requests
# Get all executions
response = requests.get(
'https://api.getcatalog.ai/v1/crawl',
headers={'x-api-key': 'YOUR_API_KEY'}
)
data = response.json()
print(f"Found {len(data['executions'])} executions")
{
"executions": [
{
"execution_id": "crawl-skims-com-9b68e2c1",
"status": "processing",
"created_at": "2026-01-09T23:05:29.401291+00:00"
}
]
}
When to use: Monitor all your crawl operations in one place. Use this endpoint to:
- See all crawl executions you’ve started
- Filter by status (processing, completed, failed)
- Track when crawls were initiated
- Find execution IDs for status checks
Request
string
required
Your API key for authentication
Query Parameters
string
Filter executions by status. Possible values:
"processing", "completed", "failed"Note: If not provided, all executions are returned regardless of status.number
Number of executions to return (default: 20)Note: Executions are returned in reverse chronological order (most recent first).
Response
array
Array of execution summary objects
Show Execution Summary
Show Execution Summary
string
Unique execution identifier. Use this ID with
GET /v1/crawl/{execution_id} to check detailed status and results.Format: crawl-{hostname}-{uuid}string
Current execution statusPossible values:
"processing"- Execution is currently running"completed"- Execution finished successfully"failed"- Execution failed or was aborted
string
ISO 8601 timestamp when the execution was created
cURL
# Get all executions
curl -X GET "https://api.getcatalog.ai/v1/crawl" \
-H "x-api-key: $CATALOG_API_KEY"
# Get only completed executions
curl -X GET "https://api.getcatalog.ai/v1/crawl?status=completed" \
-H "x-api-key: $CATALOG_API_KEY"
# Get first 50 executions
curl -X GET "https://api.getcatalog.ai/v1/crawl?limit=50" \
-H "x-api-key: $CATALOG_API_KEY"
// Get all executions
const response = await fetch('https://api.getcatalog.ai/v1/crawl', {
headers: {
'x-api-key': 'YOUR_API_KEY'
}
});
const data = await response.json();
console.log(`Found ${data.executions.length} executions`);
import requests
# Get all executions
response = requests.get(
'https://api.getcatalog.ai/v1/crawl',
headers={'x-api-key': 'YOUR_API_KEY'}
)
data = response.json()
print(f"Found {len(data['executions'])} executions")
{
"executions": [
{
"execution_id": "crawl-skims-com-9b68e2c1",
"status": "processing",
"created_at": "2026-01-09T23:05:29.401291+00:00"
}
]
}
⌘I