Get Job Status | Captain Docs

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

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

statusstring

billingobject or null

Billing/credit information for a completed indexing job. Returned when job status is ‘completed’.

cancelled_atstring or null

collection_namestring or null

completed_atstring or null

created_atstring or null

error_codestring or null

error_messagestring or null

estimated_time_remaining_secondsinteger or null

fileslist of objects or null

files_pageobject or null

job_typestring or null

progressobject or null

Detailed progress information for running jobs

progress_messagestring or null

resultobject or null

Final result data when job is completed

started_atstring or null

updated_atstring or null

1	import json
2	import requests
3
4	BASE_URL = "https://api.runcaptain.com"
5	API_KEY = "your_api_key"
6	JOB_ID = "job_abc123"
7
8	headers = {
9	"Authorization": f"Bearer {API_KEY}",
10	}
11
12	params = {
13	"files_limit": 50,
14	"files_cursor": "example_files_cursor"
15	}
16
17	response = requests.get(
18	f"{BASE_URL}/v2/jobs/{JOB_ID}",
19	headers=headers,
20	params=params,
21	timeout=30.0
22	)
23
24	print(json.dumps(response.json(), indent=2))

Path parameters

Headers

Query parameters

Response