GET /v1/processing-runs/{run_id} — Atom Files Developers

← API referenceFile intelligence · API access unavailable

API REFERENCE / FILE INTELLIGENCE

`GET` /v1/processing-runs/{run_id}

Inspect per-output progress and terminal outcome of a processing run.

Request fields

Location	Field	Type	Required	Description
Header	`Authorization`	string	Yes	Credential scoped to the authorized resource.
Path	`run_id`	string	Yes	Processing run returned by the create request.

Request example

Example request

GET /v1/processing-runs/run_123
Authorization: Bearer <scoped token>

HTTP status codes

Status	Meaning
`200 OK`	Success response shown below.
`401 Unauthorized`	Missing, expired, or invalid credential.
`403 Forbidden`	Credential is valid but lacks the required scope or role.
`404 Not Found`	Run is not visible to this caller.
`429 Too Many Requests`	Rate limit reached; honor Retry-After when provided.
`503 Service Unavailable`	Service temporarily unavailable; retry safely.

Response fields

Field	Type	Example
`id`	string	run_123
`file_id`	string	file_789
`version_id`	string	ver_012
`status`	string (enum)	running Allowed values · closed enum`queuedrunningcancellation_requestedcompletedpartially_completedfailedcancelled`
`outputs`	object[]	[2 shown]
`outputs[].kind`	string	page_ocr
`outputs[].state`	string (enum)	ready Allowed values · closed enum`not_applicabledisabledqueuedrunningpartialreadyfailedstale`
`outputs[].completed_units`	integer	12
`outputs[].total_units`	integer	12
`updated_at`	string (date-time)	2026-10-20T18:04:00Z

Response example

Example response

200 OK
Content-Type: application/json

{
  "id": "run_123",
  "file_id": "file_789",
  "version_id": "ver_012",
  "status": "running",
  "outputs": [
    {
      "kind": "page_ocr",
      "state": "ready",
      "completed_units": 12,
      "total_units": 12
    },
    {
      "kind": "document_summary",
      "state": "running",
      "completed_units": 0,
      "total_units": 1
    }
  ],
  "updated_at": "2026-10-20T18:04:00Z"
}

How it works

A run may be queued, running, cancellation_requested, completed, partially_completed, failed, or cancelled. Published outputs are listed separately from the run status and remain available unless explicitly removed.