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

FileGetStatusCountsResponse pipelines().files().getStatusCounts(FileGetStatusCountsParamsparams = FileGetStatusCountsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

Get Pipeline File Status

ManagedIngestionStatusResponse pipelines().files().getStatus(FileGetStatusParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Add Files To Pipeline Api

List<PipelineFile> pipelines().files().create(FileCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Update Pipeline File

PipelineFile pipelines().files().update(FileUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Delete Pipeline File

pipelines().files().delete(FileDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

List Pipeline Files2

Deprecated

FileListPage pipelines().files().list(FileListParamsparams = FileListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

ModelsExpand Collapse

class PipelineFile:

A file associated with a pipeline.

String id

Unique identifier for the pipeline file.

formatuuid

String pipelineId

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

formatuuid

Optional<ConfigHash> configHash

Hashes for the configuration of the pipeline.

One of the following:

class UnionMember0:

List<JsonValue>

String

double

boolean

Optional<LocalDateTime> createdAt

When the pipeline file was created.

formatdate-time

Optional<CustomMetadata> customMetadata

Custom metadata for the file.

One of the following:

class UnionMember0:

List<JsonValue>

String

double

boolean

Optional<String> dataSourceId

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

formatuuid

Optional<String> externalFileId

The ID of the file in the external system.

Optional<String> fileId

The ID of the file.

formatuuid

Optional<Long> fileSize

Size of the file in bytes.

Optional<String> fileType

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

Optional<Long> indexedPageCount

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

Optional<LocalDateTime> lastModifiedAt

The last modified time of the file.

formatdate-time

Optional<String> name

Name of the file.

Optional<PermissionInfo> permissionInfo

Permission information for the file.

One of the following:

class UnionMember0:

List<JsonValue>

String

double

boolean

Optional<String> projectId

The ID of the project that the file belongs to.

formatuuid

Optional<ResourceInfo> resourceInfo

Resource information for the file.

One of the following:

class UnionMember0:

List<JsonValue>

String

double

boolean

Optional<Status> status

Status of the pipeline file.

One of the following:

NOT_STARTED("NOT_STARTED")

IN_PROGRESS("IN_PROGRESS")

SUCCESS("SUCCESS")

ERROR("ERROR")

CANCELLED("CANCELLED")

Optional<LocalDateTime> statusUpdatedAt

The last time the status was updated.

formatdate-time

Optional<LocalDateTime> updatedAt

When the pipeline file was last updated.

formatdate-time