API Reference

Admin

Organization

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Modify project

$ openai admin:organization:projects update

POST/organization/projects/{project_id}

Modifies a project in the organization.

ParametersExpand Collapse

--project-id: string

The ID of the project.

--external-key-id: optional string

External key ID to associate with the project.

--geography: optional string

Geography for the project.

--name: optional string

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

ReturnsExpand Collapse

project: object { id, created_at, object, 4 more }

Represents an individual project.

id: string

The identifier, which can be referenced in API endpoints

created_at: number

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

object: "organization.project"

The object type, which is always organization.project

archived_at: optional number

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

external_key_id: optional string

The external key associated with the project.

name: optional string

The name of the project. This appears in reporting.

status: optional string

active or archived

Modify project

CLI Tool

HTTP

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

openai admin:organization:projects update \
  --admin-api-key 'My Admin API Key' \
  --project-id project_id

200 example

{
  "id": "id",
  "created_at": 0,
  "object": "organization.project",
  "archived_at": 0,
  "external_key_id": "external_key_id",
  "name": "name",
  "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",
  "status": "status"
}