Get Job Status

GET

https://host.com/v2/jobs/:job_id

GET

/v2/jobs/:job_id

1 import requests
2 
3 url = "https://host.com/v2/jobs/job_id"
4 
5 querystring = {"files_limit":"1","files_cursor":"files_cursor"}
6 
7 payload = {}
8 headers = {"Content-Type": "application/json"}
9 
10 response = requests.get(url, json=payload, headers=headers, params=querystring)
11 
12 print(response.json())

200Retrieved

1 {
2   "job_id": "job_123e4567-e89b-12d3-a456-426614174000",
3   "status": "completed",
4   "billing": {
5     "credits": {
6       "remaining": 12.5,
7       "used_advanced": 3,
8       "used_basic": 7,
9       "used_total": 10.5
10     },
11     "included_credits": 20,
12     "period_end": 1711929600,
13     "period_start": 1709481600
14   },
15   "cancelled_at": null,
16   "collection_name": "marketing_documents",
17   "completed_at": "2024-05-20T15:45:00Z",
18   "created_at": "2024-05-20T14:00:00Z",
19   "error_code": null,
20   "error_message": null,
21   "estimated_time_remaining_seconds": 0,
22   "files": [
23     {
24       "status": "completed",
25       "uri": "s3://company-bucket/marketing/strategy.pdf",
26       "document_id": "doc_987654321",
27       "error_code": null,
28       "error_message": null,
29       "progress_message": "Indexed successfully",
30       "stage": "indexing",
31       "updated_at": "2024-05-20T15:44:30Z"
32     }
33   ],
34   "files_page": {
35     "limit": 50,
36     "next_cursor": "eyJmaWxlX2lkIjoiZG9jXzEwMDAxIn0=",
37     "total_estimated": 120
38   },
39   "job_type": "indexing",
40   "progress": {
41     "current_stage": "finalizing",
42     "stage_description": "Finalizing indexing and updating metadata",
43     "elapsed_seconds": 6300,
44     "files_failed": 2,
45     "files_processed": 118,
46     "files_skipped": 0,
47     "files_total": 120
48   },
49   "progress_message": "Almost complete",
50   "result": {
51     "duration_seconds": 6400,
52     "failed_files": [
53       {
54         "error": "File format not supported",
55         "file_name": "old_presentation.pptx"
56       }
57     ],
58     "files_failed": 2,
59     "files_indexed": 118,
60     "files_skipped": 0,
61     "warnings": [
62       "Some files were skipped due to unsupported formats"
63     ]
64   },
65   "started_at": "2024-05-20T14:00:00Z",
66   "updated_at": "2024-05-20T15:45:00Z"
67 }

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_cursorstringOptional

Pagination cursor for files

Response

Successful Response

job_idstring

statusstring

billingobject

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

cancelled_atstring

collection_namestring

completed_atstring

created_atstring

error_codestring

error_messagestring

estimated_time_remaining_secondsinteger

fileslist of objects

files_pageobject

job_typestring

progressobject

Detailed progress information for running jobs

progress_messagestring

resultobject

Final result data when job is completed

started_atstring

updated_atstring

Path parameters

Headers

Query parameters

Response