Add Files To Pipeline Api

Deprecated

client.pipelines.files.create(, , ?): FileCreateResponse { id, pipeline_id, config_hash, 16 more }

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

Add files to a pipeline.

ParametersExpand Collapse

pipelineID: string

params: FileCreateParams { body }

body: Array<Body>

file_id: string

The ID of the file

formatuuid

Custom metadata for the file

One of the following:

Record<string, unknown>

Array<unknown>

string

number

boolean

ReturnsExpand Collapse

FileCreateResponse = Array<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

Hashes for the configuration of the pipeline.

One of the following:

Record<string, unknown>

Array<unknown>

string

number

boolean

created_at?: string | null

When the pipeline file was created.

formatdate-time

Custom metadata for the file.

One of the following:

Record<string, unknown>

Array<unknown>

string

number

boolean

data_source_id?: string | null

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

formatuuid

external_file_id?: string | null

The ID of the file in the external system.

file_id?: string | null

The ID of the file.

formatuuid

file_size?: number | null

Size of the file in bytes.

file_type?: string | null

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

indexed_page_count?: number | null

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

last_modified_at?: string | null

The last modified time of the file.

formatdate-time

name?: string | null

Name of the file.

Permission information for the file.

One of the following:

Record<string, unknown>

Array<unknown>

string

number

boolean

project_id?: string | null

The ID of the project that the file belongs to.

formatuuid

Resource information for the file.

One of the following:

Record<string, unknown>

Array<unknown>

string

number

boolean

status?: "NOT_STARTED" | "IN_PROGRESS" | "SUCCESS" | 2 more | null

Status of the pipeline file.

One of the following:

"NOT_STARTED"

"IN_PROGRESS"

"SUCCESS"

"ERROR"

"CANCELLED"

status_updated_at?: string | null

The last time the status was updated.

formatdate-time

updated_at?: string | null

When the pipeline file was last updated.

formatdate-time

Add Files To Pipeline Api

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const pipelineFiles = await client.pipelines.files.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  body: [{ file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }],
});

console.log(pipelineFiles);

[
  {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "config_hash": {
      "foo": {
        "foo": "bar"
      }
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "custom_metadata": {
      "foo": {
        "foo": "bar"
      }
    },
    "data_source_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "external_file_id": "external_file_id",
    "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "file_size": 0,
    "file_type": "file_type",
    "indexed_page_count": 0,
    "last_modified_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "permission_info": {
      "foo": {
        "foo": "bar"
      }
    },
    "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "resource_info": {
      "foo": {
        "foo": "bar"
      }
    },
    "status": "NOT_STARTED",
    "status_updated_at": "2019-12-27T18:11:19.117Z",
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]

Returns Examples

[
  {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "pipeline_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "config_hash": {
      "foo": {
        "foo": "bar"
      }
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "custom_metadata": {
      "foo": {
        "foo": "bar"
      }
    },
    "data_source_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "external_file_id": "external_file_id",
    "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "file_size": 0,
    "file_type": "file_type",
    "indexed_page_count": 0,
    "last_modified_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "permission_info": {
      "foo": {
        "foo": "bar"
      }
    },
    "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "resource_info": {
      "foo": {
        "foo": "bar"
      }
    },
    "status": "NOT_STARTED",
    "status_updated_at": "2019-12-27T18:11:19.117Z",
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]

Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/python/shared/mcp/