API Reference

Pipelines

Documents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Pipeline Document Status

Deprecated

ManagedIngestionStatusResponse Pipelines.Documents.GetStatus(DocumentGetStatusParamsparameters, CancellationTokencancellationToken = default)

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

Return a single document for a pipeline.

ParametersExpand Collapse

DocumentGetStatusParams parameters

required string pipelineID

required string documentID

ReturnsExpand Collapse

class ManagedIngestionStatusResponse:

required Status Status

Status of the ingestion.

One of the following:

"CANCELLED"Cancelled

"ERROR"Error

"IN_PROGRESS"InProgress

"NOT_STARTED"NotStarted

"PARTIAL_SUCCESS"PartialSuccess

"SUCCESS"Success

DateTimeOffset? DeploymentDate

Date of the deployment.

formatdate-time

DateTimeOffset? EffectiveAt

When the status is effective

formatdate-time

IReadOnlyList<Error>? Error

List of errors that occurred during ingestion.

required string JobID

ID of the job that failed.

formatuuid

required string Message

List of errors that occurred during ingestion.

required Step Step

Name of the job that failed.

One of the following:

"DATA_SOURCE"DataSource

"FILE_UPDATER"FileUpdater

"INGESTION"Ingestion

"MANAGED_INGESTION"ManagedIngestion

"METADATA_UPDATE"MetadataUpdate

"PARSE"Parse

"TRANSFORM"Transform

string? JobID

ID of the latest job.

formatuuid

Get Pipeline Document Status

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

DocumentGetStatusParams parameters = new()
{
    PipelineID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    DocumentID = "document_id",
};

var managedIngestionStatusResponse = await client.Pipelines.Documents.GetStatus(parameters);

Console.WriteLine(managedIngestionStatusResponse);

200 example

{
  "status": "CANCELLED",
  "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": "DATA_SOURCE"
    }
  ],
  "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}

Returns Examples

200 example

{
  "status": "CANCELLED",
  "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": "DATA_SOURCE"
    }
  ],
  "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}