Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Modify project

admin.organization.projects.update(project_id, **kwargs) -> Project
POST
/organization/projects/{project_id}

Modifies a project in the organization.

Parameters
project_id: str
external_key_id: Optional[str]

External key ID to associate with the project.

geography: Optional[str]

Deprecated.

Geography for the project. Deprecated: use residency when creating a project to configure data residency. This field is retained for backward compatibility.

name: Optional[str]

The updated name of the project, this name appears in reports.

Returns
class Project: …

Represents an individual project.

id: str

The identifier, which can be referenced in API endpoints

created_at: int

The Unix timestamp (in seconds) of when the project was created.

formatunixtime
object: Literal["organization.project"]

The object type, which is always organization.project

archived_at: Optional[int]

The Unix timestamp (in seconds) of when the project was archived or null.

formatunixtime
external_key_id: Optional[str]

The external key associated with the project.

name: Optional[str]

The name of the project. This appears in reporting.

residency: Optional[ProjectResidency]

The residency configuration for the project.

status: Optional[str]

active or archived

Modify project

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
project = client.admin.organization.projects.update(
    project_id="project_id",
)
print(project.id)
200 example
{
  "id": "id",
  "created_at": 0,
  "object": "organization.project",
  "archived_at": 0,
  "external_key_id": "external_key_id",
  "name": "name",
  "residency": "GLOBAL",
  "status": "status"
}
Returns Examples
200 example
{
  "id": "id",
  "created_at": 0,
  "object": "organization.project",
  "archived_at": 0,
  "external_key_id": "external_key_id",
  "name": "name",
  "residency": "GLOBAL",
  "status": "status"
}