Sign in
Pipelines

List Pipeline Documents

Changed on

Return a list of documents for a pipeline.

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

Request

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

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

  • 7a98f91d4000Revision changes
    • ○

      added the new optional query request parameter status_refresh_policy

    • ○

      added the optional property / to the response with the status