API Reference

Pipelines

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Files

Get Pipeline File Status Counts

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

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

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

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

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, 3 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 }

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?: Record<string, Record<string, unknown> | Array<unknown> | string | 2 more | null> | null

Hashes for the configuration of the pipeline.

Accepts one of the following:

Record<string, unknown>

Array<unknown>

string

number

boolean

created_at?: string | null

Creation datetime

formatdate-time

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

Custom metadata for the file

Accepts 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

minimum0

file_type?: string | null

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

maxLength3000

minLength1

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

maxLength3000

minLength1

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

Permission information for the file

Accepts 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

Accepts 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

Accepts 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

Update datetime

formatdate-time