Get the status, partial results, and any pending changes for an async chat job.

Returns the job's current state (pending, in_progress, awaiting_approval, completed, failed, or cancelled), intermediate AI responses streamed during execution, the final document HTML once complete, and any pending changes awaiting user approval (with chunk IDs and proposed HTML diffs in metadata.pending_changes). Poll this after chat_async to track progress and retrieve results. When status is awaiting_approval, call POST /v1/chat/{session_id}/approve to approve or deny each pending change. Headless/MCP clients get the same typed progress events the web SSE stream delivers via metadata.intermediate_responses (e.g. documents_changed, continue_prompt, model_fallback, proposed_change_batch); cross-session document updates from OTHER sessions are reported separately by polling GET /v1/sessions/{session_id}/doc-events.

get/v1/jobs/{job_id}

Request

Base URL: https://api.superdocs.app
URL: https://api.superdocs.app/v1/jobs/{job_id}
Auth: HTTP bearer

Path parameters

job_idstring required

Query parameters

compactboolean

When true, omit the heavy result body + streamed intermediate events from the response (status/progress/ids/timestamps/pending-change ids remain). Recommended for AI agents polling a large-document job: poll compact while it runs, then fetch once non-compact when status is completed to retrieve the final HTML.

Headers

authorizationstring nullable

Response

Successful Response

job_idstring required

Unique job identifier. Use this to poll for status updates.

organization_idstring nullable

Organization that owns this job (null for user jobs).

user_idstring nullable

User that owns this job (null for organization jobs).

session_idstring required

Session associated with this job.

job_typestring required

Type of job: 'chat' or 'attachment_processing'.

statusstring required

Current status: 'pending', 'in_progress', 'awaiting_approval', 'completed', 'failed', or 'cancelled'.

created_atstring required

ISO 8601 timestamp when the job was created.

updated_atstring required

ISO 8601 timestamp of the last status change.

progressinteger required

Progress percentage (0-100).

errorstring nullable

Error message. Present when status is 'failed'.

Changes

No recorded changes to this operation across all 1 revision of this API.