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(ctx, pipelineID, query) (*PipelineFileGetStatusCountsResponse, error)

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

Get Pipeline File Status

client.Pipelines.Files.GetStatus(ctx, fileID, query) (*ManagedIngestionStatusResponse, error)

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

Add Files To Pipeline Api

client.Pipelines.Files.New(ctx, pipelineID, body) (*[]PipelineFile, error)

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

Update Pipeline File

client.Pipelines.Files.Update(ctx, fileID, params) (*PipelineFile, error)

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

Delete Pipeline File

client.Pipelines.Files.Delete(ctx, fileID, body) error

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

List Pipeline Files2

Deprecated

client.Pipelines.Files.List(ctx, pipelineID, query) (*PaginatedPipelineFiles[PipelineFile], error)

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

ModelsExpand Collapse

type PipelineFile struct{…}

A file associated with a pipeline.

ID string

Unique identifier for the pipeline file.

formatuuid

PipelineID string

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

formatuuid

ConfigHash map[string, PipelineFileConfigHashUnion]optional

Hashes for the configuration of the pipeline.

One of the following:

type PipelineFileConfigHashMap map[string, any]

type PipelineFileConfigHashArray []any

string

float64

bool

CreatedAt Timeoptional

When the pipeline file was created.

formatdate-time

CustomMetadata map[string, PipelineFileCustomMetadataUnion]optional

Custom metadata for the file.

One of the following:

type PipelineFileCustomMetadataMap map[string, any]

type PipelineFileCustomMetadataArray []any

string

float64

bool

DataSourceID stringoptional

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

formatuuid

ExternalFileID stringoptional

The ID of the file in the external system.

FileID stringoptional

The ID of the file.

formatuuid

FileSize int64optional

Size of the file in bytes.

FileType stringoptional

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

IndexedPageCount int64optional

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

LastModifiedAt Timeoptional

The last modified time of the file.

formatdate-time

Name stringoptional

Name of the file.

PermissionInfo map[string, PipelineFilePermissionInfoUnion]optional

Permission information for the file.

One of the following:

type PipelineFilePermissionInfoMap map[string, any]

type PipelineFilePermissionInfoArray []any

string

float64

bool

ProjectID stringoptional

The ID of the project that the file belongs to.

formatuuid

ResourceInfo map[string, PipelineFileResourceInfoUnion]optional

Resource information for the file.

One of the following:

type PipelineFileResourceInfoMap map[string, any]

type PipelineFileResourceInfoArray []any

string

float64

bool

Status PipelineFileStatusoptional

Status of the pipeline file.

One of the following:

const PipelineFileStatusNotStarted PipelineFileStatus = "NOT_STARTED"

const PipelineFileStatusInProgress PipelineFileStatus = "IN_PROGRESS"

const PipelineFileStatusSuccess PipelineFileStatus = "SUCCESS"

const PipelineFileStatusError PipelineFileStatus = "ERROR"

const PipelineFileStatusCancelled PipelineFileStatus = "CANCELLED"

StatusUpdatedAt Timeoptional

The last time the status was updated.

formatdate-time

UpdatedAt Timeoptional

When the pipeline file was last updated.

formatdate-time