Get Project

GET/api/v1/projects/{project_id}

Get a project by ID.

Path ParametersExpand Collapse

project_id: string

Query ParametersExpand Collapse

organization_id: optional string

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

Project = object { id, name, organization_id, 4 more }

Schema for a project.

id: string

Unique identifier

formatuuid

name: string

organization_id: string

The Organization ID the project is under.

formatuuid

ad_hoc_eval_dataset_id: optional string

created_at: optional string

Creation datetime

formatdate-time

is_default: optional boolean

Whether this project is the default project for the user.

updated_at: optional string

Update datetime

formatdate-time

Get Project

curl https://api.cloud.llamaindex.ai/api/v1/projects/$PROJECT_ID \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"

{
  "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"
}