API Referencejobs

Get Job Status

Get the status of an indexing job with detailed progress information. ## Status Values - **pending**: Job created but processing hasn't started yet - **running**: Job is actively processing files - **completed**: Job finished successfully - **failed**: Job encountered an error - **cancelled**: Job was cancelled by user ## Processing Stages When status is `running`, the `progress.current_stage` field indicates which stage: 1. **scanning**: Scanning bucket for files 2. **extracting**: Extracting text content from documents 3. **chunking**: Splitting documents into semantic chunks 4. **tagging**: AI tagging and summarization 5. **embedding**: Generating vector embeddings 6. **finalizing**: Aggregating results and recording billing ## File Status Values Each file in the `files` array has a status: - **queued**: Waiting to be processed - **processing**: Currently being processed - **completed**: Successfully indexed - **failed**: Failed to process (see error_code/error_message) - **skipped**: Skipped (already indexed, unsupported type, etc.) - **cancelled**: Processing was cancelled

Path parameters

job_idstringRequired
The job ID returned from an indexing request

Headers

AuthorizationstringRequired
Captain API key for authentication

Response

Job Status
job_idstring
Unique identifier for the job
statusenum
Current job status
Allowed values:
collection_namestring or null
Name of the collection being indexed
job_typeenum or null
Type of indexing job
progress_messagestring or null

Human-readable progress message

progressobject or null
Detailed progress information including current stage and file counts
fileslist of objects or null
Array of individual file statuses
files_pageobject or null
Pagination info for the files array
resultobject or null

Final result summary (present when completed or failed)

billingobject or null
Billing details including cost, credits used, and remaining balance. Only present when status is 'completed'.
error_codestring or null
Error code if job failed
error_messagestring or null
Error message if job failed
cancelled_bystring or null

Who cancelled the job (if cancelled)

cancelled_atstring or nullformat: "date-time"
When the job was cancelled
created_atstring or nullformat: "date-time"
When the job was created
updated_atstring or nullformat: "date-time"
When the job was last updated
started_atstring or nullformat: "date-time"

When processing started (null if pending)

completed_atstring or nullformat: "date-time"

When the job finished (completed, failed, or cancelled)

estimated_time_remaining_secondsinteger or null
Estimated seconds until completion

Errors