Get Jobs

GET 
/api/v1/jobs/

Get jobs for a project.

Request

Query Parameters

job_name any
limit Limit
Possible values: <= 100
Default value: 50
offset Offset
Default value: 0
include_usage_metrics Include Usage Metrics
Default value: false
project_id any
organization_id any

Cookie Parameters

session any

Responses

200

Successful Response

application/json

Schema

Schema

jobs

object[]

required

Array [

job_record

object

required

Schema for a job's metadata.

job_name JobNames (string)required

The name of the job.

Possible values: [load_documents_job, load_files_job, playground_job, eval_dataset_job, pipeline_managed_ingestion_job, data_source_managed_ingestion_job, data_source_update_dispatcher_job, pipeline_file_update_dispatcher_job, pipeline_file_updater_job, file_managed_ingestion_job, document_ingestion_job, parse_raw_file_job, llama_parse_transform_job, metadata_update_job, parse_raw_file_job_cached, extraction_job, extract_job, asyncio_test_job]

partitions

object

required

The partitions for this execution. Used for determining where to save job output.

property name*

object

anyOf

MOD1

string

MOD2

string

parameters

object

Additional metadata for the job execution.

anyOf

Base

object

session_id

object

The upstream request ID that created this job. Used for tracking the job across services.

anyOf

MOD1

string

correlation_id

object

The correlation ID for this job. Used for tracking the job across services.

anyOf

MOD1

string

parent_job_execution_id

object

The ID of the parent job execution.

anyOf

MOD1

string

user_id

object

The ID of the user that created this job

anyOf

MOD1

string

created_at date-timerequired

Creation datetime

project_id

object

The ID of the project this job belongs to.

anyOf

MOD1

string

id uuid

Unique identifier

status StatusEnum (string)required

Enum for representing the status of a job

Possible values: [PENDING, SUCCESS, ERROR, PARTIAL_SUCCESS]

error_code

object

anyOf

MOD1

string

error_message

object

anyOf

MOD1

string

attempts

object

The number of times this job has been attempted

anyOf

MOD1

integer

started_at

object

anyOf

MOD1

string

ended_at

object

anyOf

MOD1

string

updated_at date-time

Update datetime

data

object

Additional metadata for the job execution.

anyOf

Base

object

usage_metrics

object

anyOf

UsageMetricResponse

feature_usage objectrequired

day Day (string)required

source Source (string)required

job_id Job Id (string)required

user

object

required

id Id (string)required

The user id from who triggered the job

name Name (string)required

The name of the user

]

total_count Total Count (integer)required
limit Limit (integer)required
offset Offset (integer)required

Example (from schema)

{
  "jobs": [
    {
      "job_record": {
        "job_name": "load_documents_job",
        "partitions": {},
        "parameters": {},
        "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "correlation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "parent_job_execution_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "user_id": "string",
        "created_at": "2024-07-29T15:51:28.071Z",
        "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "status": "PENDING",
        "error_code": "string",
        "error_message": "string",
        "attempts": 0,
        "started_at": "2024-07-29T15:51:28.071Z",
        "ended_at": "2024-07-29T15:51:28.071Z",
        "updated_at": "2024-07-29T15:51:28.071Z",
        "data": {}
      },
      "usage_metrics": {},
      "user": {
        "id": "string",
        "name": "string"
      }
    }
  ],
  "total_count": 0,
  "limit": 0,
  "offset": 0
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}