Archives a project in the organization. Archived projects cannot be used or updated.

POST /organization/projects/{project_id}/archive
Api key auth

Path parameters

  • project_id string Required

    The ID of the project.

Responses

  • 200 application/json

    Project archived successfully.

    Hide response attributes Show response attributes object
    • id string Required

      The identifier, which can be referenced in API endpoints

    • object string Required

      The object type, which is always organization.project

      Value is organization.project.

    • name string Required

      The name of the project. This appears in reporting.

    • created_at integer Required

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

    • archived_at integer | null

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

    • status string Required

      active or archived

      Values are active or archived.
POST /organization/projects/{project_id}/archive 
curl \
 --request POST 'https://api.openai.com/v1/organization/projects/{project_id}/archive' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id": "string",
  "object": "organization.project",
  "name": "string",
  "created_at": 42,
  "archived_at": 42,
  "status": "active"
}