List all async chat jobs for a specific session, most recent first.

GET

sessions

{session_id}

jobs

curl --request GET \
  --url https://api.example.com/v1/sessions/{session_id}/jobs \
  --header 'Authorization: Bearer <token>'

{
  "jobs": [
    {
      "job_id": "<string>",
      "session_id": "<string>",
      "job_type": "<string>",
      "status": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "progress": 123,
      "organization_id": "<string>",
      "user_id": "<string>",
      "result": {
        "response": "<string>",
        "session_id": "<string>",
        "document_changes": {
          "updated_html": "<string>",
          "version_id": "<string>",
          "changes_summary": "<string>",
          "requires_approval": true,
          "pending_changes": [
            {
              "change_id": "<string>",
              "operation": "<string>",
              "chunk_id": "<string>",
              "old_html": "<string>",
              "new_html": "<string>",
              "ai_explanation": "<string>"
            }
          ],
          "changes": [
            {}
          ],
          "chunk_diffs": [
            {
              "change_id": "<string>",
              "operation": "<string>",
              "chunk_id": "<string>",
              "old_html": "<string>",
              "new_html": "<string>",
              "ai_explanation": "<string>"
            }
          ]
        },
        "usage": {
          "monthly_used": 123,
          "monthly_limit": 123,
          "monthly_remaining": 123,
          "was_billable": true,
          "subscription_tier": "<string>",
          "bucket_used": "<string>",
          "redemption_id": "<string>",
          "promotions": [
            {
              "redemption_id": "<string>",
              "name": "<string>",
              "ops_remaining": 123,
              "ops_granted": 123,
              "expires_at": "<string>"
            }
          ]
        },
        "attachment_id": "<string>"
      },
      "error": "<string>",
      "metadata": {
        "filename": "<string>",
        "file_size": 123,
        "content_type": "<string>",
        "message": "<string>",
        "document_html_provided": true,
        "pending_changes": [
          {
            "change_id": "<string>",
            "operation": "<string>",
            "chunk_id": "<string>",
            "old_html": "<string>",
            "new_html": "<string>",
            "ai_explanation": "<string>"
          }
        ],
        "intermediate_responses": [
          {}
        ]
      }
    }
  ],
  "total": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization

string | null

Path Parameters

session_id

string

required

Query Parameters

limit

integer

default:20

Maximum number of jobs to return

Response

Successful Response

List of async jobs.

jobs

JobResponse · object[]

required

Array of job details.

Show child attributes

total

integer

required

Total number of jobs returned.

Start a long-running or HITL-approved AI edit; returns a job_id to poll for results.Use instead of chat when (a) the edit is large or multi-step, (b) you need human approval on each proposed change before it applies (set approval_mode='ask_every_time'), or (c) you can't afford to block on a synchronous response. Returns a job_id immediately. Poll get_job to track progress and retrieve the final document. Approve or deny pending changes via approve_change. Job state is durable and survives server restarts. Optional: model_tier (core/turbo/pro/max), thinking_depth (fast/balanced/deep), image_attachments for multimodal vision. RECOMMENDED for AI agents working with large documents (>20 pages): set response_mode='compact' so the job result skips the full HTML and surfaces only per-section diffs in chunk_diffs, saving thousands of tokens per poll. To read sections in compact mode, just send a natural-language chat request ('show me the pricing section') — the AI returns the content in the reply text. Always use natural language; the AI handles all internal section lookups. HITL workflow (approval_mode='ask_every_time'): 1) poll get_job until status=awaiting_approval, 2) read metadata.pending_changes for proposed edits, 3) call approve_change per change, 4) continue polling until status=completed.

List all async chat jobs for a specific session, most recent first.

curl --request GET \
  --url https://api.example.com/v1/sessions/{session_id}/jobs \
  --header 'Authorization: Bearer <token>'

{
  "jobs": [
    {
      "job_id": "<string>",
      "session_id": "<string>",
      "job_type": "<string>",
      "status": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "progress": 123,
      "organization_id": "<string>",
      "user_id": "<string>",
      "result": {
        "response": "<string>",
        "session_id": "<string>",
        "document_changes": {
          "updated_html": "<string>",
          "version_id": "<string>",
          "changes_summary": "<string>",
          "requires_approval": true,
          "pending_changes": [
            {
              "change_id": "<string>",
              "operation": "<string>",
              "chunk_id": "<string>",
              "old_html": "<string>",
              "new_html": "<string>",
              "ai_explanation": "<string>"
            }
          ],
          "changes": [
            {}
          ],
          "chunk_diffs": [
            {
              "change_id": "<string>",
              "operation": "<string>",
              "chunk_id": "<string>",
              "old_html": "<string>",
              "new_html": "<string>",
              "ai_explanation": "<string>"
            }
          ]
        },
        "usage": {
          "monthly_used": 123,
          "monthly_limit": 123,
          "monthly_remaining": 123,
          "was_billable": true,
          "subscription_tier": "<string>",
          "bucket_used": "<string>",
          "redemption_id": "<string>",
          "promotions": [
            {
              "redemption_id": "<string>",
              "name": "<string>",
              "ops_remaining": 123,
              "ops_granted": 123,
              "expires_at": "<string>"
            }
          ]
        },
        "attachment_id": "<string>"
      },
      "error": "<string>",
      "metadata": {
        "filename": "<string>",
        "file_size": 123,
        "content_type": "<string>",
        "message": "<string>",
        "document_html_provided": true,
        "pending_changes": [
          {
            "change_id": "<string>",
            "operation": "<string>",
            "chunk_id": "<string>",
            "old_html": "<string>",
            "new_html": "<string>",
            "ai_explanation": "<string>"
          }
        ],
        "intermediate_responses": [
          {}
        ]
      }
    }
  ],
  "total": 123
}