Pipelines

Get Pipeline Status

Changed on

Get the ingestion status of a managed pipeline.

Returns document counts, sync progress, and the last effective timestamp. Only available for managed pipelines.

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

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v1/pipelines/{pipeline_id}/status
  • Auth: HTTP bearer

Path parameters

pipeline_idstring uuid required

Query parameters

full_detailsboolean nullable
project_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

job_idstring uuid nullable

ID of the latest job.

deployment_datestring date-time nullable

Date of the deployment.

status'NOT_STARTED' | 'IN_PROGRESS' | 'SUCCESS' | 'ERROR' | 'PARTIAL_SUCCESS' | 'CANCELLED' required

Status of managed ingestion with partial Updates.

effective_atstring date-time nullable

When the status is effective

Changes

  • a38b684f8e1bRevision changes
    • info

      endpoint deprecated

    • info

      added the new optional query request parameter project_id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 614771991b52Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status