Get Pipeline Document

GET 
/api/v1/pipelines/:pipeline_id/documents/:document_id

Return a single document for a pipeline.

Request

Path Parameters

document_id Document Idrequired
pipeline_id uuidrequired

Cookie Parameters

session any

Responses

200

Successful Response

application/json

Schema

Schema

text Text (string)required
metadata objectrequired
excluded_embed_metadata_keys string[]
Default value: []
excluded_llm_metadata_keys string[]
Default value: []

page_positions

object

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

anyOf

MOD1

Array [

integer

]

id Id (string)required

Example (from schema)

{
  "text": "string",
  "metadata": {},
  "excluded_embed_metadata_keys": [
    "string"
  ],
  "excluded_llm_metadata_keys": [
    "string"
  ],
  "page_positions": [
    null
  ],
  "id": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}