Skip to content
Product Docs

Get Project

projects.get(strproject_id, ProjectGetParams**kwargs) -> Project
GET/api/v2/projects/{project_id}

Get a project by ID.

ParametersExpand Collapse
project_id: str
organization_id: Optional[str]
ReturnsExpand Collapse
class Project:

API response schema for a project.

id: str

The project’s unique identifier.

name: str

The project’s display name.

organization_id: str

The organization the project belongs to.

created_at: Optional[datetime]

Creation datetime

formatdate-time
is_default: Optional[bool]

Whether this project is the default project for its organization.

updated_at: Optional[datetime]

Update datetime

formatdate-time

Get Project

import os
from llama_cloud_admin import LlamaCloudAdmin

client = LlamaCloudAdmin(
    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)
{
  "id": "id",
  "name": "name",
  "organization_id": "organization_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "is_default": true,
  "updated_at": "2019-12-27T18:11:19.117Z"
}
Returns Examples
{
  "id": "id",
  "name": "name",
  "organization_id": "organization_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "is_default": true,
  "updated_at": "2019-12-27T18:11:19.117Z"
}