API Reference

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Project

projects.get(strproject_id, ProjectGetParams**kwargs) -> Project

GET/api/v1/projects/{project_id}

Get a project by ID.

ParametersExpand Collapse

project_id: str

organization_id: Optional[str]

ReturnsExpand Collapse

class Project: …

Schema for a project.

id: str

Unique identifier

formatuuid

name: str

organization_id: str

The Organization ID the project is under.

formatuuid

created_at: Optional[datetime]

Creation datetime

formatdate-time

is_default: Optional[bool]

Whether this project is the default project for the user.

updated_at: Optional[datetime]

Update datetime

formatdate-time

Get Project

Python

HTTP

TypeScript

Python

Java

Go

CLI Tool

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
project = client.projects.get(
    project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(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"
}