Skip to main content
GET
/
v1
/
projects
/
{project_id}
/
jobs
List Jobs
curl --request GET \
  --url https://api.example.com/v1/projects/{project_id}/jobs \
  --header 'x-api-key: <api-key>' \
  --header 'x-selected-account-id: <api-key>'
{
  "items": [
    {
      "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": {}
        }
      ]
    }
  ],
  "total_count": 123,
  "next_token": "<string>",
  "prev_token": "<string>"
}

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

Query Parameters

​
ids
string[] | null

Filter by job IDs

​
created_at_start
string<date-time> | null

Filter by creation time (start)

​
created_at_end
string<date-time> | null

Filter by creation time (end)

​
completed_at_start
string<date-time> | null

Filter by completion time (start)

​
completed_at_end
string<date-time> | null

Filter by completion time (end)

​
status
enum<string> | null

Filter by job status Enum for job status values.

Available options:
pending,
running,
succeeded,
partially_succeeded,
failed,
cancelled
​
operation
enum<string> | null

Filter by job operation type Enum for job operation values.

Available options:
parse,
batch_parse,
extract,
research,
vector_store,
chunk,
summarization,
create_index,
update_index
​
page_size
integer | null

Number of items per page

Required range: 1 <= x <= 100
​
sort_by
string | null

Field to sort by

​
sort_order
enum<string> | null

Sort order (asc or desc) Enum for project sort fields. Note that only non-nullable fields can be sorted by (for details, see: https://github.com/djrobstep/sqlakeyset?tab=readme-ov-file#limitations ).

Available options:
asc,
desc
​
continuation_token
string | null

Pagination token

Response

Successful Response

​
items
JobEntity · object[]
required
​
total_count
integer
required
​
next_token
string | null
​
prev_token
string | null