Sign in
Pipelines

List Pipeline Documents

Return a list of documents for a pipeline.

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

Path parameters

pipeline_idstring uuid required

Query parameters

skipinteger
limitinteger
file_idstring uuid nullable
only_direct_uploadboolean nullable
only_api_data_source_documentsboolean nullable
status_refresh_policy'cached' | 'ttl'

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

Changed in 1 of the 33 revisions of this API.2

  • b17341164de92See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog