Projects

Modify project

Changed on

Modifies a project in the organization.

post/organization/projects/{project_id}

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/organization/projects/{project_id}
  • Auth
    HTTP bearer

Path parameters

project_idstring required

The ID of the project.

Request body

namestring nullable

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

external_key_idstring nullable

External key ID to associate with the project.

geographystring nullable

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

Response

Project updated successfully.

idstring required

The identifier, which can be referenced in API endpoints

object'organization.project' required

The object type, which is always organization.project

namestring nullable

The name of the project. This appears in reporting.

created_atinteger required

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

archived_atinteger nullable

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

statusstring nullable

active or archived

external_key_idstring nullable

The external key associated with the project.

residency'GLOBAL' | 'US_STORAGE_PROCESSING' | 'EU_STORAGE_PROCESSING' | 'JP_STORAGE' | 'JP_STORAGE_PROCESSING' | 'KR_STORAGE' | 'CA_STORAGE' | 'SG_STORAGE' | 'IN_STORAGE' | 'IN_STORAGE_PROCESSING' | 'AU_STORAGE' | 'AU_STORAGE_PROCESSING' | 'GB_STORAGE' | 'AE_STORAGE' | 'AE_STORAGE_PROCESSING'

Changes

  • 6e0ebb1ed7fcRevision changes
    • warning

      added the new AU_STORAGE_PROCESSING enum value to the response property for the response status

    • warning

      added the new IN_STORAGE_PROCESSING enum value to the response property for the response status

    • warning

      added the new JP_STORAGE_PROCESSING enum value to the response property for the response status

  • e2f8d8cbc41fRevision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status