Get job status
GET /v1/jobs/{id}
Auth: Bearer API keyRate limit: Plan dependent

Returns the status, result, error, and webhook state for an async capture job.

Request

idstringrequiredpath

Async job id returned from POST /v1/capture when async: true.

bash
curl "https://screenframed.com/v1/jobs/job_01K..." \ -H "Authorization: Bearer $SCREENFRAMED_API_KEY"

Response

statusstring

Current job status: pending, completed, or failed.

resultobject | null

Completed capture result. null until the job completes.

errorstring | null

Failure message for failed jobs.

Completed 200
json
{ "id": "job_01K...", "status": "completed", "result": { "id": "cap_01K...", "url": "https://cdn.screenframed.com/r/cap_01K....png", "width": 1600, "height": 900, "format": "png", "credits_used": 3 }, "error": null, "webhook_url": "https://example.com/webhooks/screenframed", "webhook_status": "delivered", "created_at": "2026-04-27 15:00:00", "completed_at": "2026-04-27 15:00:04"}
Ask a question... ⌘I