Get Job Status | Captain Docs

import requests
import json
BASE_URL = "https://api.runcaptain.com"
API_KEY = "your_api_key"
JOB_ID = "job_abc123"
headers = {
    "Authorization": f"Bearer {API_KEY}",
}
response = requests.get(
    f"{BASE_URL}/v2/jobs/{JOB_ID}",
    headers=headers,
    timeout=30.0
)
if response.status_code == 200:
    data = response.json()
    print(f"Status: {data['status']}")
    for f in data.get("files") or []:
        print(f"  {f['uri']} -> {f['status']} (document_id={f.get('document_id')})")
else:
    print(f"Error: {response.status_code}")

{
  "job_id": "abc123xyz-1234567890",
  "status": "pending",
  "collection_name": "my_documents",
  "created_at": "2024-01-15T10:30:00Z",
  "estimated_time_remaining_seconds": 0,
  "job_type": "index_s3_directory",
  "progress_message": "Job pending",
  "started_at": null,
  "updated_at": "2024-01-15T10:30:00Z"
}

Get status, progress, and file-level details for an indexing job. Use files_limit and files_cursor to page through indexed files when the job contains many inputs.

Path parameters

job_idstringRequired

ID of the job to look up, as returned by the indexing endpoint that started it.

Query parameters

files_limitintegerOptional1-500Defaults to 50

Number of files to return per page

files_cursorstring or nullOptional

Pagination cursor for files

Response

Successful Response

job_idstring

Unique identifier for the indexing job, as returned by the indexing endpoint that started it.

statusstring

Current job status.

pending: queued, not yet started
running: in progress; see progress for the current stage
completed: all files indexed successfully
completed_with_errors: finished, but some files failed; see files and result
failed: the job failed; see error_code and error_message
cancelled: cancelled via DELETE /v2/jobs/{job_id}
timed_out: execution exceeded the time limit

billingobject or nullOptional

Credit usage for this job. Present only when the job has completed.

cancelled_atstring or nullOptional

RFC 3339 timestamp when the job was cancelled.

collection_namestring or nullOptional

Name of the collection this job is indexing into.

completed_atstring or nullOptional

RFC 3339 timestamp when the job reached a terminal state.

created_atstring or nullOptional

RFC 3339 timestamp when the job was created.

error_codestring or nullOptional

Machine-readable error code. Present when the job failed.

error_messagestring or nullOptional

Human-readable error message. Present when the job failed.

estimated_time_remaining_secondsinteger or nullOptional

Estimated seconds until the job finishes. 0 once the job is in a terminal state.

fileslist of objects or nullOptional

Per-file status for the files in this job. Paginated: control the page with the files_limit and files_cursor query parameters.

files_pageobject or nullOptional

Pagination details for files. Pass next_cursor as the files_cursor query parameter to fetch the next page.

job_typestring or nullOptional

The indexing operation that created this job, e.g. index_s3_directory. Matches the endpoint the job was started from.

progressobject or nullOptional

Detailed progress for a running job: the current pipeline stage and per-file counts.

progress_messagestring or nullOptional

Human-readable summary of the job’s current progress.

resultobject or nullOptional

Final file counts and duration once the job reaches a terminal state.

started_atstring or nullOptional

RFC 3339 timestamp when processing began. Null while the job is pending.

updated_atstring or nullOptional

RFC 3339 timestamp when the job was last updated.

Path parameters

Headers

Query parameters

Response