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

Deprecated

pipelines.files.get_status_counts(strpipeline_id, FileGetStatusCountsParams**kwargs) -> FileGetStatusCountsResponse

GET/api/v1/pipelines/{pipeline_id}/files/status-counts

Get Pipeline File Status

Deprecated

pipelines.files.get_status(strfile_id, FileGetStatusParams**kwargs) -> ManagedIngestionStatusResponse

GET/api/v1/pipelines/{pipeline_id}/files/{file_id}/status

Add Files To Pipeline Api

Deprecated

pipelines.files.create(strpipeline_id, FileCreateParams**kwargs) -> FileCreateResponse

PUT/api/v1/pipelines/{pipeline_id}/files

Update Pipeline File

Deprecated

pipelines.files.update(strfile_id, FileUpdateParams**kwargs) -> PipelineFile

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

Delete Pipeline File

Deprecated

pipelines.files.delete(strfile_id, FileDeleteParams**kwargs)

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

List Pipeline Files2

Deprecated

pipelines.files.list(strpipeline_id, FileListParams**kwargs) -> SyncPaginatedPipelineFiles[PipelineFile]

GET/api/v1/pipelines/{pipeline_id}/files2

ModelsExpand Collapse

class PipelineFile: …

A file associated with a pipeline.

id: str

Unique identifier for the pipeline file.

formatuuid

pipeline_id: str

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

formatuuid

config_hash: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]

Hashes for the configuration of the pipeline.

One of the following:

Dict[str, object]

List[object]

str

float

bool

created_at: Optional[datetime]

When the pipeline file was created.

formatdate-time

custom_metadata: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]

Custom metadata for the file.

One of the following:

Dict[str, object]

List[object]

str

float

bool

data_source_id: Optional[str]

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

formatuuid

external_file_id: Optional[str]

The ID of the file in the external system.

file_id: Optional[str]

The ID of the file.

formatuuid

file_size: Optional[int]

Size of the file in bytes.

file_type: Optional[str]

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

indexed_page_count: Optional[int]

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

last_modified_at: Optional[datetime]

The last modified time of the file.

formatdate-time

name: Optional[str]

Name of the file.

permission_info: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]

Permission information for the file.

One of the following:

Dict[str, object]

List[object]

str

float

bool

project_id: Optional[str]

The ID of the project that the file belongs to.

formatuuid

resource_info: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]

Resource information for the file.

One of the following:

Dict[str, object]

List[object]

str

float

bool

status: Optional[Literal["NOT_STARTED", "IN_PROGRESS", "SUCCESS", 2 more]]

Status of the pipeline file.

One of the following:

"NOT_STARTED"

"IN_PROGRESS"

"SUCCESS"

"ERROR"

"CANCELLED"

status_updated_at: Optional[datetime]

The last time the status was updated.

formatdate-time

updated_at: Optional[datetime]

When the pipeline file was last updated.

formatdate-time

class FileGetStatusCountsResponse: …

counts: Dict[str, int]

The counts of files by status

total_count: int

The total number of files

data_source_id: Optional[str]

The ID of the data source that the files belong to

formatuuid

only_manually_uploaded: Optional[bool]

Whether to only count manually uploaded files

pipeline_id: Optional[str]

The ID of the pipeline that the files belong to

formatuuid

List[PipelineFile]

id: str

Unique identifier for the pipeline file.

formatuuid

pipeline_id: str

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

formatuuid

config_hash: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]

Hashes for the configuration of the pipeline.

One of the following:

Dict[str, object]

List[object]

str

float

bool

created_at: Optional[datetime]

When the pipeline file was created.

formatdate-time

custom_metadata: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]

Custom metadata for the file.

One of the following:

Dict[str, object]

List[object]

str

float

bool

data_source_id: Optional[str]

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

formatuuid

external_file_id: Optional[str]

The ID of the file in the external system.

file_id: Optional[str]

The ID of the file.

formatuuid

file_size: Optional[int]

Size of the file in bytes.

file_type: Optional[str]

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

indexed_page_count: Optional[int]

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

last_modified_at: Optional[datetime]

The last modified time of the file.

formatdate-time

name: Optional[str]

Name of the file.

permission_info: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]

Permission information for the file.

One of the following:

Dict[str, object]

List[object]

str

float

bool

project_id: Optional[str]

The ID of the project that the file belongs to.

formatuuid

resource_info: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]

Resource information for the file.

One of the following:

Dict[str, object]

List[object]

str

float

bool

status: Optional[Literal["NOT_STARTED", "IN_PROGRESS", "SUCCESS", 2 more]]

Status of the pipeline file.

One of the following:

"NOT_STARTED"

"IN_PROGRESS"

"SUCCESS"

"ERROR"

"CANCELLED"

status_updated_at: Optional[datetime]

The last time the status was updated.

formatdate-time

updated_at: Optional[datetime]

When the pipeline file was last updated.

formatdate-time