Sign in
Pipelines

Paginated List Pipeline Documents

Changed on

Return a list of documents for a pipeline.

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

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

limitinteger required

The limit of the documents

offsetinteger required

The offset of the documents

total_countinteger required

The total number of documents

Changes

  • 7a98f91d4000Revision changes
    • ○

      added the new optional query request parameter status_refresh_policy

    • ○

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