Get Pipeline Document Status

pipelines.documents.get_status(, ) -> ManagedIngestionStatusResponse

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

Return a single document for a pipeline.

ParametersExpand Collapse

pipeline_id: str

document_id: str

ReturnsExpand Collapse

class ManagedIngestionStatusResponse: …

status: Literal["NOT_STARTED", "IN_PROGRESS", "SUCCESS", 3 more]

Status of the ingestion.

Accepts one of the following:

"NOT_STARTED"

"IN_PROGRESS"

"SUCCESS"

"ERROR"

"PARTIAL_SUCCESS"

"CANCELLED"

deployment_date: Optional[datetime]

Date of the deployment.

formatdate-time

effective_at: Optional[datetime]

When the status is effective

formatdate-time

error: Optional[List[Error]]

List of errors that occurred during ingestion.

job_id: str

ID of the job that failed.

formatuuid

message: str

List of errors that occurred during ingestion.

step: Literal["MANAGED_INGESTION", "DATA_SOURCE", "FILE_UPDATER", 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[str]

ID of the latest job.

formatuuid

Get Pipeline Document Status

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
managed_ingestion_status_response = client.pipelines.documents.get_status(
    document_id="document_id",
    pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(managed_ingestion_status_response.job_id)

{
  "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"
}