Get Job Status

1 import requests 2 import time 3 4 BASE_URL = "https://api.runcaptain.com" 5 API_KEY = "your_api_key" 6 job_id = "your_job_id" 7 8 headers = { 9 "Authorization": f"Bearer {API_KEY}" 10 } 11 12 # Poll until completion 13 while True: 14 response = requests.get( 15 f"{BASE_URL}/v2/jobs/{job_id}", 16 headers=headers, 17 timeout=30.0 18 ) 19 20 if response.status_code == 200: 21 result = response.json() 22 status = result.get("status") 23 progress = result.get("progress_message", "") 24 print(f"Status: {status} - {progress}") 25 26 if status in ['completed', 'failed', 'cancelled']: 27 if status == "completed": 28 print("Job completed successfully!") 29 final = result.get("result", {}) 30 print(f"Files indexed: {final.get('files_indexed', 0)}") 31 else: 32 print(f"Job {status}") 33 break 34 else: 35 print(f"Error: {response.status_code}") 36 break 37 38 time.sleep(5)

1 { 2 "job_id": "abc123xyz-1234567890", 3 "status": "running", 4 "job_type": "index_s3", 5 "progress_message": "Processing files... (elapsed: 45s)", 6 "created_at": "2024-01-15T10:30:00Z", 7 "updated_at": "2024-01-15T10:30:45Z", 8 "estimated_time_remaining_seconds": 22 9 }

Get the status of an indexing job.

Consolidates v1’s /indexing-status and /index-status endpoints.

Returns:

job_id: The job identifier
job_type: Type of job (index_s3, index_s3_file, index_gcs, index_gcs_file)
status: pending | running | completed | failed | cancelled
progress_message: Human-readable progress
result: Final result data (when completed)
error_code/error_message: Error details (when failed)

Get the status of an indexing job. Consolidates v1's /indexing-status and /index-status endpoints. Returns: - job_id: The job identifier - job_type: Type of job (index_s3, index_s3_file, index_gcs, index_gcs_file) - status: pending | running | completed | failed | cancelled - progress_message: Human-readable progress - result: Final result data (when completed) - error_code/error_message: Error details (when failed)

Path parameters

job_idstringRequired

The job ID to check status for

Response

Job Status

job_idstring

statusenum

Allowed values:

job_typeenum or null

Allowed values:

progress_messagestring or null

resultobject or null

error_codestring or null

error_messagestring or null

cancelled_bystring or null

cancelled_atstring or null

created_atstring or null

updated_atstring or null

execution_arnstring or null

estimated_time_remaining_secondsinteger or null

Path parameters

Headers

Response

Errors