Add Files To Pipeline

PUT 
/api/v1/pipelines/:pipeline_id/files

Add files to a pipeline.

Request

Path Parameters

pipeline_id uuidrequired

Cookie Parameters

session any

application/json

Body

array

required

• Array [

file_id uuidrequired

The ID of the file

custom_metadata

object

Custom metadata for the file

anyOf

MOD1

property name*

object

anyOf

MOD1

object

MOD2

Array [

]

MOD3

string

MOD4

integer

MOD5

number

MOD6

boolean

• ]

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

id uuidrequired

Unique identifier

created_at

object

Creation datetime

anyOf

MOD1

string

updated_at

object

Update datetime

anyOf

MOD1

string

name

object

anyOf

MOD1

string

Possible values: non-empty and <= 3000 characters

file_size

object

Size of the file in bytes

anyOf

MOD1

integer

file_type

object

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

anyOf

MOD1

string

Possible values: non-empty and <= 3000 characters

project_id uuidrequired

The ID of the project that the file belongs to

last_modified_at

object

The last modified time of the file

anyOf

MOD1

string

resource_info

object

Resource information for the file

anyOf

MOD1

property name*

object

anyOf

MOD1

object

MOD2

Array [

]

MOD3

string

MOD4

integer

MOD5

number

MOD6

boolean

permission_info

object

Permission information for the file

anyOf

MOD1

property name*

object

anyOf

MOD1

object

MOD2

Array [

]

MOD3

string

MOD4

integer

MOD5

number

MOD6

boolean

data_source_id

object

The ID of the data source that the file belongs to

anyOf

MOD1

string

file_id

object

The ID of the file

anyOf

MOD1

string

pipeline_id uuidrequired

The ID of the pipeline that the file is associated with

custom_metadata

object

Custom metadata for the file

anyOf

MOD1

property name*

object

anyOf

MOD1

object

MOD2

Array [

]

MOD3

string

MOD4

integer

MOD5

number

MOD6

boolean

config_hash

object

Hashes for the configuration of the pipeline.

anyOf

MOD1

property name*

object

anyOf

MOD1

object

MOD2

Array [

]

MOD3

string

MOD4

integer

MOD5

number

MOD6

boolean

indexed_page_count

object

The number of pages that have been indexed for this file

anyOf

MOD1

integer

• ]

Example (from schema)

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "name": "string",
    "file_size": 0,
    "file_type": "string",
    "project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "last_modified_at": "2024-07-29T15:51:28.071Z",
    "resource_info": {},
    "permission_info": {},
    "data_source_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "file_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "pipeline_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "custom_metadata": {},
    "config_hash": {},
    "indexed_page_count": 0
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}