Skip to content
Developer Documentation
API Reference
Pipelines

Files

Get Pipeline File Status Counts
Deprecated
client.pipelines.files.getStatusCounts(stringpipelineID, FileGetStatusCountsParams { data_source_id, only_manually_uploaded } query?, RequestOptionsoptions?): FileGetStatusCountsResponse { counts, total_count, data_source_id, 2 more }
GET/api/v1/pipelines/{pipeline_id}/files/status-counts
Get Pipeline File Status
Deprecated
client.pipelines.files.getStatus(stringfileID, FileGetStatusParams { pipeline_id } params, RequestOptionsoptions?): ManagedIngestionStatusResponse { status, deployment_date, effective_at, 2 more }
GET/api/v1/pipelines/{pipeline_id}/files/{file_id}/status
Add Files To Pipeline Api
Deprecated
client.pipelines.files.create(stringpipelineID, FileCreateParams { body } params, RequestOptionsoptions?): FileCreateResponse { id, pipeline_id, config_hash, 16 more }
PUT/api/v1/pipelines/{pipeline_id}/files
Update Pipeline File
Deprecated
client.pipelines.files.update(stringfileID, FileUpdateParams { pipeline_id, custom_metadata } params, RequestOptionsoptions?): PipelineFile { id, pipeline_id, config_hash, 16 more }
PUT/api/v1/pipelines/{pipeline_id}/files/{file_id}
Delete Pipeline File
Deprecated
client.pipelines.files.delete(stringfileID, FileDeleteParams { pipeline_id } params, RequestOptionsoptions?): void
DELETE/api/v1/pipelines/{pipeline_id}/files/{file_id}
List Pipeline Files2
Deprecated
client.pipelines.files.list(stringpipelineID, FileListParams { data_source_id, file_name_contains, limit, 4 more } query?, RequestOptionsoptions?): PaginatedPipelineFiles<PipelineFile { id, pipeline_id, config_hash, 16 more } >
GET/api/v1/pipelines/{pipeline_id}/files2
ModelsExpand Collapse
PipelineFile { id, pipeline_id, config_hash, 16 more }

A file associated with a pipeline.

id: string

Unique identifier for the pipeline file.

formatuuid
pipeline_id: string

The ID of the pipeline that the file is associated with.

formatuuid
config_hash?: Record<string, Record<string, unknown> | Array<unknown> | string | 2 more | null> | null

Hashes for the configuration of the pipeline.

One of the following:
Record<string, unknown>
Array<unknown>
string
number
boolean
created_at?: string | null

When the pipeline file was created.

formatdate-time
custom_metadata?: Record<string, Record<string, unknown> | Array<unknown> | string | 2 more | null> | null

Custom metadata for the file.

One of the following:
Record<string, unknown>
Array<unknown>
string
number
boolean
data_source_id?: string | null

The ID of the data source that the file belongs to.

formatuuid
external_file_id?: string | null

The ID of the file in the external system.

file_id?: string | null

The ID of the file.

formatuuid
file_size?: number | null

Size of the file in bytes.

file_type?: string | null

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

indexed_page_count?: number | null

The number of pages that have been indexed for this file.

last_modified_at?: string | null

The last modified time of the file.

formatdate-time
name?: string | null

Name of the file.

permission_info?: Record<string, Record<string, unknown> | Array<unknown> | string | 2 more | null> | null

Permission information for the file.

One of the following:
Record<string, unknown>
Array<unknown>
string
number
boolean
project_id?: string | null

The ID of the project that the file belongs to.

formatuuid
resource_info?: Record<string, Record<string, unknown> | Array<unknown> | string | 2 more | null> | null

Resource information for the file.

One of the following:
Record<string, unknown>
Array<unknown>
string
number
boolean
status?: "NOT_STARTED" | "IN_PROGRESS" | "SUCCESS" | 2 more | null

Status of the pipeline file.

One of the following:
"NOT_STARTED"
"IN_PROGRESS"
"SUCCESS"
"ERROR"
"CANCELLED"
status_updated_at?: string | null

The last time the status was updated.

formatdate-time
updated_at?: string | null

When the pipeline file was last updated.

formatdate-time
FileGetStatusCountsResponse { counts, total_count, data_source_id, 2 more }
counts: Record<string, number>

The counts of files by status

total_count: number

The total number of files

data_source_id?: string | null

The ID of the data source that the files belong to

formatuuid
only_manually_uploaded?: boolean

Whether to only count manually uploaded files

pipeline_id?: string | null

The ID of the pipeline that the files belong to

formatuuid
FileCreateResponse = Array<PipelineFile { id, pipeline_id, config_hash, 16 more } >
id: string

Unique identifier for the pipeline file.

formatuuid
pipeline_id: string

The ID of the pipeline that the file is associated with.

formatuuid
config_hash?: Record<string, Record<string, unknown> | Array<unknown> | string | 2 more | null> | null

Hashes for the configuration of the pipeline.

One of the following:
Record<string, unknown>
Array<unknown>
string
number
boolean
created_at?: string | null

When the pipeline file was created.

formatdate-time
custom_metadata?: Record<string, Record<string, unknown> | Array<unknown> | string | 2 more | null> | null

Custom metadata for the file.

One of the following:
Record<string, unknown>
Array<unknown>
string
number
boolean
data_source_id?: string | null

The ID of the data source that the file belongs to.

formatuuid
external_file_id?: string | null

The ID of the file in the external system.

file_id?: string | null

The ID of the file.

formatuuid
file_size?: number | null

Size of the file in bytes.

file_type?: string | null

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

indexed_page_count?: number | null

The number of pages that have been indexed for this file.

last_modified_at?: string | null

The last modified time of the file.

formatdate-time
name?: string | null

Name of the file.

permission_info?: Record<string, Record<string, unknown> | Array<unknown> | string | 2 more | null> | null

Permission information for the file.

One of the following:
Record<string, unknown>
Array<unknown>
string
number
boolean
project_id?: string | null

The ID of the project that the file belongs to.

formatuuid
resource_info?: Record<string, Record<string, unknown> | Array<unknown> | string | 2 more | null> | null

Resource information for the file.

One of the following:
Record<string, unknown>
Array<unknown>
string
number
boolean
status?: "NOT_STARTED" | "IN_PROGRESS" | "SUCCESS" | 2 more | null

Status of the pipeline file.

One of the following:
"NOT_STARTED"
"IN_PROGRESS"
"SUCCESS"
"ERROR"
"CANCELLED"
status_updated_at?: string | null

The last time the status was updated.

formatdate-time
updated_at?: string | null

When the pipeline file was last updated.

formatdate-time
Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/python/shared/mcp/