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

Projects

Archive project
$ openai admin:organization:projects archive
POST
/organization/projects/{project_id}/archive
Create project
$ openai admin:organization:projects create
POST
/organization/projects
List projects
$ openai admin:organization:projects list
GET
/organization/projects
Retrieve project
$ openai admin:organization:projects retrieve
GET
/organization/projects/{project_id}
Modify project
$ openai admin:organization:projects update
POST
/organization/projects/{project_id}
Models
project: object { id, created_at, object, 5 more }

Represents an individual project.

project_residency: "GLOBAL" or "US_STORAGE_PROCESSING" or "EU_STORAGE_PROCESSING" or 12 more

ProjectsAPI Keys

Delete project API key
$ openai admin:organization:projects:api-keys delete
DELETE
/organization/projects/{project_id}/api_keys/{api_key_id}
List project API keys
$ openai admin:organization:projects:api-keys list
GET
/organization/projects/{project_id}/api_keys
Retrieve project API key
$ openai admin:organization:projects:api-keys retrieve
GET
/organization/projects/{project_id}/api_keys/{api_key_id}
Update project API key
$ openai admin:organization:projects:api-keys update
POST
/organization/projects/{project_id}/api_keys/{api_key_id}
Models
project_api_key: object { id, created_at, last_used_at, 6 more }

Represents an individual API key in a project.

ProjectsCertificates

Activate certificates for project
$ openai admin:organization:projects:certificates activate
POST
/organization/projects/{project_id}/certificates/activate
Deactivate certificates for project
$ openai admin:organization:projects:certificates deactivate
POST
/organization/projects/{project_id}/certificates/deactivate
List project certificates
$ openai admin:organization:projects:certificates list
GET
/organization/projects/{project_id}/certificates

ProjectsData Retention

Retrieve project data retention
$ openai admin:organization:projects:data-retention retrieve
GET
/organization/projects/{project_id}/data_retention
Update project data retention
$ openai admin:organization:projects:data-retention update
POST
/organization/projects/{project_id}/data_retention
Models
project_data_retention: object { object, type }

Represents a project’s data retention control setting.

ProjectsGroups

Add project group
$ openai admin:organization:projects:groups create
POST
/organization/projects/{project_id}/groups
Remove project group
$ openai admin:organization:projects:groups delete
DELETE
/organization/projects/{project_id}/groups/{group_id}
List project groups
$ openai admin:organization:projects:groups list
GET
/organization/projects/{project_id}/groups
Retrieve project group
$ openai admin:organization:projects:groups retrieve
GET
/organization/projects/{project_id}/groups/{group_id}
Models
project_group: object { created_at, group_id, group_name, 3 more }

Details about a group’s membership in a project.

ProjectsGroupsRoles

Assign project role to group
$ openai admin:organization:projects:groups:roles create
POST
/projects/{project_id}/groups/{group_id}/roles
Unassign project role from group
$ openai admin:organization:projects:groups:roles delete
DELETE
/projects/{project_id}/groups/{group_id}/roles/{role_id}
List project group role assignments
$ openai admin:organization:projects:groups:roles list
GET
/projects/{project_id}/groups/{group_id}/roles
Retrieve project group role
$ openai admin:organization:projects:groups:roles retrieve
GET
/projects/{project_id}/groups/{group_id}/roles/{role_id}

ProjectsHosted Tool Permissions

Retrieve project hosted tool permissions
$ openai admin:organization:projects:hosted-tool-permissions retrieve
GET
/organization/projects/{project_id}/hosted_tool_permissions
Modify project hosted tool permissions
$ openai admin:organization:projects:hosted-tool-permissions update
POST
/organization/projects/{project_id}/hosted_tool_permissions
Models
project_hosted_tool_permissions: object { code_interpreter, file_search, image_generation, 2 more }

Represents hosted tool permissions for a project.

ProjectsModel Permissions

Delete project model permissions
$ openai admin:organization:projects:model-permissions delete
DELETE
/organization/projects/{project_id}/model_permissions
Retrieve project model permissions
$ openai admin:organization:projects:model-permissions retrieve
GET
/organization/projects/{project_id}/model_permissions
Modify project model permissions
$ openai admin:organization:projects:model-permissions update
POST
/organization/projects/{project_id}/model_permissions
Models
project_model_permissions: object { mode, model_ids, object }

Represents the model allowlist or denylist policy for a project.

project_model_permissions_deleted: object { deleted, object }

Confirmation payload returned after deleting project model permissions.

ProjectsRate Limits

List project rate limits
$ openai admin:organization:projects:rate-limits list-rate-limits
GET
/organization/projects/{project_id}/rate_limits
Modify project rate limit
$ openai admin:organization:projects:rate-limits update-rate-limit
POST
/organization/projects/{project_id}/rate_limits/{rate_limit_id}
Models
project_rate_limit: object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more }

Represents a project rate limit config.

ProjectsRoles

Create project role
$ openai admin:organization:projects:roles create
POST
/projects/{project_id}/roles
Delete project role
$ openai admin:organization:projects:roles delete
DELETE
/projects/{project_id}/roles/{role_id}
List project roles
$ openai admin:organization:projects:roles list
GET
/projects/{project_id}/roles
Retrieve project role
$ openai admin:organization:projects:roles retrieve
GET
/projects/{project_id}/roles/{role_id}
Update project role
$ openai admin:organization:projects:roles update
POST
/projects/{project_id}/roles/{role_id}

ProjectsService Accounts

Create project service account
$ openai admin:organization:projects:service-accounts create
POST
/organization/projects/{project_id}/service_accounts
Delete project service account
$ openai admin:organization:projects:service-accounts delete
DELETE
/organization/projects/{project_id}/service_accounts/{service_account_id}
List project service accounts
$ openai admin:organization:projects:service-accounts list
GET
/organization/projects/{project_id}/service_accounts
Retrieve project service account
$ openai admin:organization:projects:service-accounts retrieve
GET
/organization/projects/{project_id}/service_accounts/{service_account_id}
Update project service account
$ openai admin:organization:projects:service-accounts update
POST
/organization/projects/{project_id}/service_accounts/{service_account_id}
Models
project_service_account: object { id, created_at, name, 2 more }

Represents an individual service account in a project.

ProjectsService AccountsAPI Keys

Create an API key for a service account
$ openai admin:organization:projects:service-accounts:api-keys create
POST
/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys

ProjectsSpend Alerts

Create project spend alert
$ openai admin:organization:projects:spend-alerts create
POST
/organization/projects/{project_id}/spend_alerts
Delete project spend alert
$ openai admin:organization:projects:spend-alerts delete
DELETE
/organization/projects/{project_id}/spend_alerts/{alert_id}
List project spend alerts
$ openai admin:organization:projects:spend-alerts list
GET
/organization/projects/{project_id}/spend_alerts
Retrieve project spend alert
$ openai admin:organization:projects:spend-alerts retrieve
GET
/organization/projects/{project_id}/spend_alerts/{alert_id}
Update project spend alert
$ openai admin:organization:projects:spend-alerts update
POST
/organization/projects/{project_id}/spend_alerts/{alert_id}
Models
project_spend_alert: object { id, currency, interval, 3 more }

Represents a spend alert configured at the project level.

project_spend_alert_deleted: object { id, deleted, object }

Confirmation payload returned after deleting a project spend alert.

ProjectsSpend Limit

Delete project spend limit
$ openai admin:organization:projects:spend-limit delete
DELETE
/organization/projects/{project_id}/spend_limit
Get project spend limit
$ openai admin:organization:projects:spend-limit retrieve
GET
/organization/projects/{project_id}/spend_limit
Update project spend limit
$ openai admin:organization:projects:spend-limit update
POST
/organization/projects/{project_id}/spend_limit
Models
project_spend_limit: object { currency, enforcement, interval, 2 more }

Represents a hard spend limit configured at the project level.

project_spend_limit_deleted: object { deleted, object }

Confirmation payload returned after deleting a project hard spend limit.

ProjectsUsers

Create project user
$ openai admin:organization:projects:users create
POST
/organization/projects/{project_id}/users
Delete project user
$ openai admin:organization:projects:users delete
DELETE
/organization/projects/{project_id}/users/{user_id}
List project users
$ openai admin:organization:projects:users list
GET
/organization/projects/{project_id}/users
Retrieve project user
$ openai admin:organization:projects:users retrieve
GET
/organization/projects/{project_id}/users/{user_id}
Modify project user
$ openai admin:organization:projects:users update
POST
/organization/projects/{project_id}/users/{user_id}
Models
project_user: object { id, added_at, object, 3 more }

Represents an individual user in a project.

ProjectsUsersRoles

Assign project role to user
$ openai admin:organization:projects:users:roles create
POST
/projects/{project_id}/users/{user_id}/roles
Unassign project role from user
$ openai admin:organization:projects:users:roles delete
DELETE
/projects/{project_id}/users/{user_id}/roles/{role_id}
List project user role assignments
$ openai admin:organization:projects:users:roles list
GET
/projects/{project_id}/users/{user_id}/roles
Retrieve project user role
$ openai admin:organization:projects:users:roles retrieve
GET
/projects/{project_id}/users/{user_id}/roles/{role_id}