Meet the new Scripe, live on October 7.Register

OpenAPI reference · Jobs

Get a single job (with progress snapshot)

GET/jobs/{jobId}

Returns the job row plus the latest progress snapshot pulled from Redis. Customers polling for completion should call this endpoint and inspect data.status and data.progress.

Authorization

  • Authorizationstringrequired

    Bearer token in the Authorization header.

    Pass Authorization: Bearer scripe_sk_live_<...> (or scripe_sk_test_<...> for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.

    The same header also accepts an OAuth 2.1 access token (scripe_oat_*); both credentials share one scope vocabulary and every operation below documents the scope it requires. An API key can hold every scope named on this surface except webhooks:manage, which is grantable to OAuth tokens only today — the webhook-endpoint operations answer 403 scope_missing to every API key. Operations that name no scope accept any valid token of the workspace.

Path parameters

  • jobIdstringrequired

Header parameters

  • Scripe-Api-Versionstring

    Pin the API version. Format YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return 400 version_unsupported.

Responses

  • 200

    Job found.

  • 401

    Missing, malformed, expired, or revoked API key.

  • 403

    Plan not eligible, scope missing, or workspace mismatch.

  • 404

    Resource not found in this workspace.

  • 429

    Sliding-window rate limit exceeded.

Example request

bash
curl --request GET \
  --url 'https://api.scripe.io/v1/jobs/{jobId}' \
  --header 'Authorization: Bearer <token>'

Example response (200)

json
{
  "data": {
    "id": "job_a1b2c3d4e5f6g7h8",
    "type": "POST_GENERATION",
    "status": "QUEUED",
    "projectId": "string",
    "startedAt": "2026-08-10T09:00:00Z",
    "completedAt": "2026-08-10T09:00:00Z",
    "progress": {
      "progress": 0,
      "message": "string",
      "updatedAt": "2026-08-10T09:00:00Z"
    },
    "result": {},
    "errorCode": "string",
    "errorMessage": "string",
    "attemptCount": 0,
    "estimatedCompletionMs": 0,
    "createdAt": "2026-08-10T09:00:00Z",
    "updatedAt": "2026-08-10T09:00:00Z"
  }
}