API Reference

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Project

client.projects.get(stringprojectID, ProjectGetParams { organization_id } query?, RequestOptionsoptions?): Project { id, name, organization_id, 3 more }

GET/api/v1/projects/{project_id}

Get a project by ID.

ParametersExpand Collapse

projectID: string

query: ProjectGetParams { organization_id }

organization_id?: string | null

ReturnsExpand Collapse

Project { id, name, organization_id, 3 more }

Schema for a project.

id: string

Unique identifier

formatuuid

name: string

organization_id: string

The Organization ID the project is under.

formatuuid

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

Get Project

TypeScript

HTTP

TypeScript

Python

Java

Go

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

const project = await client.projects.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(project.id);

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "name": "x",
  "organization_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

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "name": "x",
  "organization_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"
}