Get Pipeline Status

GET/api/v1/pipelines/{pipeline_id}/status

Get the status of a pipeline by ID.

Path ParametersExpand Collapse

pipeline_id: string

Query ParametersExpand Collapse

full_details: optional boolean

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

ManagedIngestionStatusResponse = object { status, deployment_date, effective_at, 2 more }

status: "NOT_STARTED" or "IN_PROGRESS" or "SUCCESS" or 3 more

Status of the ingestion.

Accepts one of the following:

"NOT_STARTED"

"IN_PROGRESS"

"SUCCESS"

"ERROR"

"PARTIAL_SUCCESS"

"CANCELLED"

deployment_date: optional string

Date of the deployment.

formatdate-time

effective_at: optional string

When the status is effective

formatdate-time

error: optional array of object { job_id, message, step }

List of errors that occurred during ingestion.

job_id: string

ID of the job that failed.

formatuuid

message: string

List of errors that occurred during ingestion.

step: "MANAGED_INGESTION" or "DATA_SOURCE" or "FILE_UPDATER" or 4 more

Name of the job that failed.

Accepts one of the following:

"MANAGED_INGESTION"

"DATA_SOURCE"

"FILE_UPDATER"

"PARSE"

"TRANSFORM"

"INGESTION"

"METADATA_UPDATE"

job_id: optional string

ID of the latest job.

formatuuid

Get Pipeline Status

curl https://api.cloud.llamaindex.ai/api/v1/pipelines/$PIPELINE_ID/status \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"

{
  "status": "NOT_STARTED",
  "deployment_date": "2019-12-27T18:11:19.117Z",
  "effective_at": "2019-12-27T18:11:19.117Z",
  "error": [
    {
      "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "message": "message",
      "step": "MANAGED_INGESTION"
    }
  ],
  "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}

Returns Examples

{
  "status": "NOT_STARTED",
  "deployment_date": "2019-12-27T18:11:19.117Z",
  "effective_at": "2019-12-27T18:11:19.117Z",
  "error": [
    {
      "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "message": "message",
      "step": "MANAGED_INGESTION"
    }
  ],
  "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}