Skip to content
LlamaIndex API Docs
Get started
API Reference
Pipelines

Files

Get Pipeline File Status Counts
GET/api/v1/pipelines/{pipeline_id}/files/status-counts
Get Pipeline File Status
GET/api/v1/pipelines/{pipeline_id}/files/{file_id}/status
Add Files To Pipeline Api
PUT/api/v1/pipelines/{pipeline_id}/files
Update Pipeline File
PUT/api/v1/pipelines/{pipeline_id}/files/{file_id}
Delete Pipeline File
DELETE/api/v1/pipelines/{pipeline_id}/files/{file_id}
List Pipeline Files2
Deprecated
GET/api/v1/pipelines/{pipeline_id}/files2
ModelsExpand Collapse
PipelineFile = object { id, pipeline_id, config_hash, 16 more }

Schema for a file that is associated with a pipeline.

id: string

Unique identifier

formatuuid
pipeline_id: string

The ID of the pipeline that the file is associated with

formatuuid
config_hash: optional map[map[unknown] or array of unknown or string or 2 more]

Hashes for the configuration of the pipeline.

Accepts one of the following:
UnionMember0 = map[unknown]
UnionMember1 = array of unknown
UnionMember2 = string
UnionMember3 = number
UnionMember4 = boolean
created_at: optional string

Creation datetime

formatdate-time
custom_metadata: optional map[map[unknown] or array of unknown or string or 2 more]

Custom metadata for the file

Accepts one of the following:
UnionMember0 = map[unknown]
UnionMember1 = array of unknown
UnionMember2 = string
UnionMember3 = number
UnionMember4 = boolean
data_source_id: optional string

The ID of the data source that the file belongs to

formatuuid
external_file_id: optional string

The ID of the file in the external system

file_id: optional string

The ID of the file

formatuuid
file_size: optional number

Size of the file in bytes

minimum0
file_type: optional string

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

maxLength3000
minLength1
indexed_page_count: optional number

The number of pages that have been indexed for this file

last_modified_at: optional string

The last modified time of the file

formatdate-time
name: optional string

Name of the file

maxLength3000
minLength1
permission_info: optional map[map[unknown] or array of unknown or string or 2 more]

Permission information for the file

Accepts one of the following:
UnionMember0 = map[unknown]
UnionMember1 = array of unknown
UnionMember2 = string
UnionMember3 = number
UnionMember4 = boolean
project_id: optional string

The ID of the project that the file belongs to

formatuuid
resource_info: optional map[map[unknown] or array of unknown or string or 2 more]

Resource information for the file

Accepts one of the following:
UnionMember0 = map[unknown]
UnionMember1 = array of unknown
UnionMember2 = string
UnionMember3 = number
UnionMember4 = boolean
status: optional "NOT_STARTED" or "IN_PROGRESS" or "SUCCESS" or 2 more

Status of the pipeline file

Accepts one of the following:
"NOT_STARTED"
"IN_PROGRESS"
"SUCCESS"
"ERROR"
"CANCELLED"
status_updated_at: optional string

The last time the status was updated

formatdate-time
updated_at: optional string

Update datetime

formatdate-time