List Projects

client.projects.list(?, ?): ProjectListResponse { id, name, organization_id, 4 more }

GET/api/v1/projects

List projects or get one by name

ParametersExpand Collapse

query: ProjectListParams { organization_id, project_name }

organization_id?: string | null

project_name?: string | null

ReturnsExpand Collapse

ProjectListResponse = Array<Project { id, name, organization_id, 4 more } >

id: string

Unique identifier

formatuuid

name: string

organization_id: string

The Organization ID the project is under.

formatuuid

ad_hoc_eval_dataset_id?: string | null

created_at?: string | null

Creation datetime

formatdate-time

is_default?: boolean

Whether this project is the default project for the user.

updated_at?: string | null

Update datetime

formatdate-time

List Projects

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 projects = await client.projects.list();

console.log(projects);

[
  {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "name": "x",
    "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "ad_hoc_eval_dataset_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created_at": "2019-12-27T18:11:19.117Z",
    "is_default": true,
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]

Returns Examples

[
  {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "name": "x",
    "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "ad_hoc_eval_dataset_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created_at": "2019-12-27T18:11:19.117Z",
    "is_default": true,
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]