Sign in
Pipeline Files

Update Pipeline File

Changed on

Update a file for a pipeline.

put/api/v1/pipelines/{pipeline_id}/files/{file_id}

Request

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

Path parameters

file_idstring uuid required
pipeline_idstring uuid required

Cookies

sessionstring nullable

Request body

custom_metadataobject nullable

Custom metadata for the file

Response

Successful Response

idstring uuid required

Unique identifier

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

namestring nullable

Name of the file

external_file_idstring nullable

The ID of the file in the external system

file_sizeinteger nullable

Size of the file in bytes

file_typestring nullable

File type (e.g. pdf, docx, etc.)

project_idstring uuid nullable

The ID of the project that the file belongs to

last_modified_atstring date-time nullable

The last modified time of the file

file_idstring uuid nullable

The ID of the file

pipeline_idstring uuid required

The ID of the pipeline that the file is associated with

resource_infoobject nullable

Resource information for the file

permission_infoobject nullable

Permission information for the file

custom_metadataobject nullable

Custom metadata for the file

data_source_idstring uuid nullable

The ID of the data source that the file belongs to

config_hashobject nullable

Hashes for the configuration of the pipeline.

indexed_page_countinteger nullable

The number of pages that have been indexed for this file

status'NOT_STARTED' | 'IN_PROGRESS' | 'SUCCESS' | 'ERROR' | 'CANCELLED' nullable

Status of the pipeline file

status_updated_atstring date-time nullable

The last time the status was updated

Changes

  • 7a98f91d4000Revision changes
    • ○

      api tag Pipeline Files added

    • ○

      api tag Pipelines removed

  • 07b7155e4e0eRevision changes
    • ▲

      the response property became optional for the status

    • ▲

      response property project_id list-of-types was widened by adding types null to media type application/json of response 200