API Reference

Pipelines

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Pipelines

client.pipelines.listPaginated(PipelineListPaginatedParams { name, organization_id, page_size, 3 more } query?, RequestOptionsoptions?): PaginatedCursor<PipelineListPaginatedResponse { id, name, pipeline_type, 4 more } >

GET/api/v2/pipelines

List the pipelines in a project, newest first.

ParametersExpand Collapse

query: PipelineListPaginatedParams { name, organization_id, page_size, 3 more }

name?: string | null

organization_id?: string | null

page_size?: number | null

page_token?: string | null

pipeline_type?: "MANAGED" | "PLAYGROUND" | null

One of the following:

"MANAGED"

"PLAYGROUND"

project_id?: string | null

ReturnsExpand Collapse

PipelineListPaginatedResponse { id, name, pipeline_type, 4 more }

A pipeline in a project.

id: string

The pipeline’s unique identifier.

name: string

The pipeline’s display name.

pipeline_type: "MANAGED" | "PLAYGROUND"

The pipeline’s type.

One of the following:

"MANAGED"

"PLAYGROUND"

project_id: string

The project the pipeline belongs to.

created_at?: string | null

Creation datetime

formatdate-time

status?: "CREATED" | "DELETING" | null

The pipeline’s current status.

One of the following:

"CREATED"

"DELETING"

updated_at?: string | null

Update datetime

formatdate-time

List Pipelines

TypeScript

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

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
});

// Automatically fetches more pages as needed.
for await (const pipelineListPaginatedResponse of client.pipelines.listPaginated()) {
  console.log(pipelineListPaginatedResponse.id);
}

200 example

{
  "items": [
    {
      "id": "id",
      "name": "name",
      "pipeline_type": "MANAGED",
      "project_id": "project_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "status": "CREATED",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

200 example

{
  "items": [
    {
      "id": "id",
      "name": "name",
      "pipeline_type": "MANAGED",
      "project_id": "project_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "status": "CREATED",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}