Pipelines

List Pipeline Documents

Changed on

Return a list of documents for a pipeline.

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

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v1/pipelines/{pipeline_id}/documents
  • 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'
project_idstring uuid nullable

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

  • a38b684f8e1bRevision changes
    • warning

      for the query request parameter limit, the max was set to 1000.00

    • info

      endpoint deprecated

    • info

      added the new optional query request parameter project_id

    • info

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

    • info

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

  • 614771991b52Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status