Update Existing Project

client.projects.update(, , ?): Project { id, name, organization_id, 3 more }

PUT/api/v2/projects/{project_id}

Update an existing project.

ParametersExpand Collapse

projectID: string

params: ProjectUpdateParams { name, organization_id }

name: string

Body param: The project’s new display name.

maxLength3000

minLength1

organization_id?: string | null

Query param

formatuuid

ReturnsExpand Collapse

Project { id, name, organization_id, 3 more }

API response schema for a project.

id: string

The project’s unique identifier.

name: string

The project’s display name.

organization_id: string

The organization the project belongs to.

created_at?: string | null

Creation datetime

formatdate-time

is_default?: boolean

Whether this project is the default project for its organization.

updated_at?: string | null

Update datetime

formatdate-time

Update Existing Project

import LlamaCloudAdmin from '@llamaindex/llama-cloud-admin';

const client = new LlamaCloudAdmin({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const project = await client.projects.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', { name: 'x' });

console.log(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"
}