DocumentationAsync Jobs
Async Jobs
Queue renders for background processing.
POST
/v1/jobsCreate a job
Queue a capture and return immediately.
Create a job
curl -X POST https://api.ssapi.com/v1/jobs \
-H "Content-Type: application/json" \
-H "X-Access-Key: your-key" \
-d '{"url":"https://example.com","format":"png"}'
{
"request_id": "...",
"result": {
"job_id": "123",
"status": "queued",
"status_url": "/v1/jobs/123"
}
}
Poll status
curl https://api.ssapi.com/v1/jobs/123 \
-H "X-Access-Key: your-key"
Get results
curl https://api.ssapi.com/v1/jobs/123/result \
-H "X-Access-Key: your-key"
Cancel a job
curl -X DELETE https://api.ssapi.com/v1/jobs/123 \
-H "X-Access-Key: your-key"
Webhooks
Add a webhook to avoid polling. See Webhooks.
Updated 1 day ago