Skip to main content
GET
/
v1
/
projects
/
{project_id}
/
jobs
/
{job_id}
Get Job
curl --request GET \
  --url https://api.example.com/v1/projects/{project_id}/jobs/{job_id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-selected-account-id: <api-key>'
{
  "id": "<string>",
  "project_id": "<string>",
  "operation": "parse",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "object": "job",
  "source_id": "<string>",
  "correlation_id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "result": {},
  "progress": {
    "total": 123,
    "succeeded": 123,
    "failed": 123,
    "cancelled": 123,
    "pending": 123,
    "child_jobs": [
      {
        "source_document_id": "<string>",
        "job_id": "<string>",
        "status": "pending",
        "parse_result_id": "<string>",
        "error": "<string>"
      }
    ]
  },
  "error": "<string>",
  "history": [
    {
      "step": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "status": "<string>",
      "details": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

API key for authentication

x-selected-account-id
string
header
required

Selected Account ID

Path Parameters

project_id
string
required
job_id
string
required

Response

Successful Response

Job response model representing an asynchronous operation.

id
string
required

ID of the entity

project_id
string
required

ID of the project

operation
enum<string>
required

Operation type (e.g., 'parse')

Available options:
parse,
batch_parse,
extract,
research,
vector_store,
chunk,
summarization,
create_index,
update_index
status
enum<string>
required

Current job status

Available options:
pending,
running,
succeeded,
partially_succeeded,
failed,
cancelled
created_at
string<date-time>
required

When the job was created

object
string
default:job
Allowed value: "job"
source_id
string | null

Source document/file ID

correlation_id
string | null

Request correlation ID for tracing

started_at
string<date-time> | null

When the job started processing

completed_at
string<date-time> | null

When the job completed

result
Result · object

Job result payload when completed

progress
BatchParseProgress · object

Live progress payload (used by batch jobs)

error
string | null

Error message if job failed

history
JobHistoryEvent · object[] | null

Timeline of job execution events