Files

Get Pipeline File Status Counts

Deprecated

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

Get Pipeline File Status

Deprecated

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

Add Files To Pipeline Api

Deprecated

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

Update Pipeline File

Deprecated

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

Delete Pipeline File

Deprecated

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

List Pipeline Files2

Deprecated

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

ModelsExpand Collapse

PipelineFile object { 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: optional map[map[unknown] or array of unknown or string or 2 more]

Hashes for the configuration of the pipeline.

One of the following:

map[unknown]

array of unknown

string

number

boolean

created_at: optional string

When the pipeline file was created.

formatdate-time

custom_metadata: optional map[map[unknown] or array of unknown or string or 2 more]

Custom metadata for the file.

One of the following:

map[unknown]

array of unknown

string

number

boolean

data_source_id: optional string

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

formatuuid

external_file_id: optional string

The ID of the file in the external system.

file_id: optional string

The ID of the file.

formatuuid

file_size: optional number

Size of the file in bytes.

file_type: optional string

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

indexed_page_count: optional number

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

last_modified_at: optional string

The last modified time of the file.

formatdate-time

name: optional string

Name of the file.

permission_info: optional map[map[unknown] or array of unknown or string or 2 more]

Permission information for the file.

One of the following:

map[unknown]

array of unknown

string

number

boolean

project_id: optional string

The ID of the project that the file belongs to.

formatuuid

resource_info: optional map[map[unknown] or array of unknown or string or 2 more]

Resource information for the file.

One of the following:

map[unknown]

array of unknown

string

number

boolean

status: optional "CANCELLED" or "ERROR" or "IN_PROGRESS" or 2 more

Status of the pipeline file.

One of the following:

"CANCELLED"

"ERROR"

"IN_PROGRESS"

"NOT_STARTED"

"SUCCESS"

status_updated_at: optional string

The last time the status was updated.

formatdate-time

updated_at: optional string

When the pipeline file was last updated.

formatdate-time

FileGetStatusCountsResponse object { counts, total_count, data_source_id, 2 more }

counts: map[number]

The counts of files by status

total_count: number

The total number of files

data_source_id: optional string

The ID of the data source that the files belong to

formatuuid

only_manually_uploaded: optional boolean

Whether to only count manually uploaded files

pipeline_id: optional string

The ID of the pipeline that the files belong to

formatuuid

FileCreateResponse = array of 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: optional map[map[unknown] or array of unknown or string or 2 more]

Hashes for the configuration of the pipeline.

One of the following:

map[unknown]

array of unknown

string

number

boolean

created_at: optional string

When the pipeline file was created.

formatdate-time

custom_metadata: optional map[map[unknown] or array of unknown or string or 2 more]

Custom metadata for the file.

One of the following:

map[unknown]

array of unknown

string

number

boolean

data_source_id: optional string

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

formatuuid

external_file_id: optional string

The ID of the file in the external system.

file_id: optional string

The ID of the file.

formatuuid

file_size: optional number

Size of the file in bytes.

file_type: optional string

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

indexed_page_count: optional number

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

last_modified_at: optional string

The last modified time of the file.

formatdate-time

name: optional string

Name of the file.

permission_info: optional map[map[unknown] or array of unknown or string or 2 more]

Permission information for the file.

One of the following:

map[unknown]

array of unknown

string

number

boolean

project_id: optional string

The ID of the project that the file belongs to.

formatuuid

resource_info: optional map[map[unknown] or array of unknown or string or 2 more]

Resource information for the file.

One of the following:

map[unknown]

array of unknown

string

number

boolean

status: optional "CANCELLED" or "ERROR" or "IN_PROGRESS" or 2 more

Status of the pipeline file.

One of the following:

"CANCELLED"

"ERROR"

"IN_PROGRESS"

"NOT_STARTED"

"SUCCESS"

status_updated_at: optional string

The last time the status was updated.

formatdate-time

updated_at: optional string

When the pipeline file was last updated.

formatdate-time