Pipeline Files

Update Pipeline File

Changed on

Update a file for a pipeline.

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

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}/files/{file_id}
  • Auth: HTTP bearer

Path parameters

file_idstring uuid required
pipeline_idstring uuid required

Query parameters

project_idstring uuid nullable

Cookies

sessionstring nullable

Request body

custom_metadataobject nullable

Custom metadata for the file

Response

Successful Response

idstring uuid required

Unique identifier for the pipeline file.

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.

created_atstring date-time nullable

When the pipeline file was created.

updated_atstring date-time nullable

When the pipeline file was last updated.

Changes

  • a38b684f8e1bRevision changes
    • 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