Sign in
Pipelines

Get Pipeline Document

Changed on

Return a single document for a pipeline.

get/api/v1/pipelines/{pipeline_id}/documents/{document_id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

document_idstring required
pipeline_idstring uuid required

Cookies

sessionstring nullable

Response

Successful Response

textstring required
metadataobject required
excluded_embed_metadata_keysstring[]
excluded_llm_metadata_keysstring[]
page_positionsinteger[] nullable

indices in the CloudDocument.text where a new page begins. e.g. Second page starts at index specified by page_positions[1].

idstring required
status_metadataobject nullable

Changes