API Reference

Admin

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Organization

OrganizationAdmin API Keys

Create admin API key

$ openai admin:organization:admin-api-keys create

POST/organization/admin_api_keys

Delete admin API key

$ openai admin:organization:admin-api-keys delete

DELETE/organization/admin_api_keys/{key_id}

List all organization and project API keys.

$ openai admin:organization:admin-api-keys list

GET/organization/admin_api_keys

Retrieve admin API key

$ openai admin:organization:admin-api-keys retrieve

GET/organization/admin_api_keys/{key_id}

ModelsExpand Collapse

admin_api_key: object { id, created_at, expires_at, 5 more }

Represents an individual Admin API key in an org.

OrganizationAudit Logs

List user actions and configuration changes within this organization.

List audit logs

$ openai admin:organization:audit-logs list

GET/organization/audit_logs

OrganizationCertificates

Activate certificates for organization

$ openai admin:organization:certificates activate

POST/organization/certificates/activate

Upload certificate

$ openai admin:organization:certificates create

POST/organization/certificates

Deactivate certificates for organization

$ openai admin:organization:certificates deactivate

POST/organization/certificates/deactivate

Delete certificate

$ openai admin:organization:certificates delete

DELETE/organization/certificates/{certificate_id}

List organization certificates

$ openai admin:organization:certificates list

GET/organization/certificates

Get certificate

$ openai admin:organization:certificates retrieve

GET/organization/certificates/{certificate_id}

Modify certificate

$ openai admin:organization:certificates update

POST/organization/certificates/{certificate_id}

ModelsExpand Collapse

certificate: object { id, certificate_details, created_at, 3 more }

Represents an individual certificate uploaded to the organization.

OrganizationData Retention

Retrieve organization data retention

$ openai admin:organization:data-retention retrieve

GET/organization/data_retention

Update organization data retention

$ openai admin:organization:data-retention update

POST/organization/data_retention

ModelsExpand Collapse

organization_data_retention: object { object, type }

Represents the organization’s data retention control setting.

OrganizationGroups

Create group

$ openai admin:organization:groups create

POST/organization/groups

Delete group

$ openai admin:organization:groups delete

DELETE/organization/groups/{group_id}

List groups

$ openai admin:organization:groups list

GET/organization/groups

Retrieve group

$ openai admin:organization:groups retrieve

GET/organization/groups/{group_id}

Update group

$ openai admin:organization:groups update

POST/organization/groups/{group_id}

ModelsExpand Collapse

group: object { id, created_at, group_type, 2 more }

Details about an organization group.

OrganizationGroupsRoles

Assign organization role to group

$ openai admin:organization:groups:roles create

POST/organization/groups/{group_id}/roles

Unassign organization role from group

$ openai admin:organization:groups:roles delete

DELETE/organization/groups/{group_id}/roles/{role_id}

List group organization role assignments

$ openai admin:organization:groups:roles list

GET/organization/groups/{group_id}/roles

Retrieve group organization role

$ openai admin:organization:groups:roles retrieve

GET/organization/groups/{group_id}/roles/{role_id}

OrganizationGroupsUsers

Add group user

$ openai admin:organization:groups:users create

POST/organization/groups/{group_id}/users

Remove group user

$ openai admin:organization:groups:users delete

DELETE/organization/groups/{group_id}/users/{user_id}

List group users

$ openai admin:organization:groups:users list

GET/organization/groups/{group_id}/users

Retrieve group user

$ openai admin:organization:groups:users retrieve

GET/organization/groups/{group_id}/users/{user_id}

ModelsExpand Collapse

organization_group_user: object { id, email, name }

Represents an individual user returned when inspecting group membership.

OrganizationInvites

Create invite

$ openai admin:organization:invites create

POST/organization/invites

Delete invite

$ openai admin:organization:invites delete

DELETE/organization/invites/{invite_id}

List invites

$ openai admin:organization:invites list

GET/organization/invites

Retrieve invite

$ openai admin:organization:invites retrieve

GET/organization/invites/{invite_id}

ModelsExpand Collapse

invite: object { id, created_at, email, 6 more }

Represents an individual invite to the organization.

OrganizationProjects

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}

ModelsExpand Collapse

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

Represents an individual project.

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

OrganizationProjectsAPI 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}

ModelsExpand Collapse

project_api_key: object { id, created_at, last_used_at, 5 more }

Represents an individual API key in a project.

OrganizationProjectsCertificates

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

OrganizationProjectsData 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

ModelsExpand Collapse

project_data_retention: object { object, type }

Represents a project’s data retention control setting.

OrganizationProjectsGroups

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}

ModelsExpand Collapse

project_group: object { created_at, group_id, group_name, 3 more }

Details about a group’s membership in a project.

OrganizationProjectsGroupsRoles

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}

OrganizationProjectsHosted 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

ModelsExpand Collapse

project_hosted_tool_permissions: object { code_interpreter, file_search, image_generation, 2 more }

Represents hosted tool permissions for a project.

OrganizationProjectsModel 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

ModelsExpand Collapse

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.

OrganizationProjectsRate 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}

ModelsExpand Collapse

project_rate_limit: object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more }

Represents a project rate limit config.

OrganizationProjectsRoles

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}

OrganizationProjectsService 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}

ModelsExpand Collapse

project_service_account: object { id, created_at, name, 2 more }

Represents an individual service account in a project.

OrganizationProjectsService AccountsAPI Keys

Create project service account API key

$ openai admin:organization:projects:service-accounts:api-keys create

POST/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys

OrganizationProjectsSpend 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}

ModelsExpand Collapse

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.

OrganizationProjectsSpend Limit

Delete project spend limit

$ openai admin:organization:projects:spend-limit delete

DELETE/organization/projects/{project_id}/spend_limit

Retrieve 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

ModelsExpand Collapse

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.

OrganizationProjectsUsers

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}

ModelsExpand Collapse

project_user: object { id, added_at, object, 3 more }

Represents an individual user in a project.

OrganizationProjectsUsersRoles

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}

OrganizationRoles

Create organization role

$ openai admin:organization:roles create

POST/organization/roles

Delete organization role

$ openai admin:organization:roles delete

DELETE/organization/roles/{role_id}

List organization roles

$ openai admin:organization:roles list

GET/organization/roles

Retrieve organization role

$ openai admin:organization:roles retrieve

GET/organization/roles/{role_id}

Update organization role

$ openai admin:organization:roles update

POST/organization/roles/{role_id}

ModelsExpand Collapse

role: object { id, description, name, 4 more }

Details about a role that can be assigned through the public Roles API.

OrganizationSpend Alerts

Create organization spend alert

$ openai admin:organization:spend-alerts create

POST/organization/spend_alerts

Delete organization spend alert

$ openai admin:organization:spend-alerts delete

DELETE/organization/spend_alerts/{alert_id}

List organization spend alerts

$ openai admin:organization:spend-alerts list

GET/organization/spend_alerts

Retrieve organization spend alert

$ openai admin:organization:spend-alerts retrieve

GET/organization/spend_alerts/{alert_id}

Update organization spend alert

$ openai admin:organization:spend-alerts update

POST/organization/spend_alerts/{alert_id}

ModelsExpand Collapse

organization_spend_alert: object { id, currency, interval, 3 more }

Represents a spend alert configured at the organization level.

organization_spend_alert_deleted: object { id, deleted, object }

Confirmation payload returned after deleting an organization spend alert.

OrganizationSpend Limit

Delete organization spend limit

$ openai admin:organization:spend-limit delete

DELETE/organization/spend_limit

Retrieve organization spend limit

$ openai admin:organization:spend-limit retrieve

GET/organization/spend_limit

Update organization spend limit

$ openai admin:organization:spend-limit update

POST/organization/spend_limit

ModelsExpand Collapse

organization_spend_limit: object { currency, enforcement, interval, 2 more }

Represents a hard spend limit configured at the organization level.

organization_spend_limit_deleted: object { deleted, object }

Confirmation payload returned after deleting an organization hard spend limit.

OrganizationUsage

Audio speeches

$ openai admin:organization:usage audio-speeches

GET/organization/usage/audio_speeches

Audio transcriptions

$ openai admin:organization:usage audio-transcriptions

GET/organization/usage/audio_transcriptions

Code interpreter sessions

$ openai admin:organization:usage code-interpreter-sessions

GET/organization/usage/code_interpreter_sessions

Completions

$ openai admin:organization:usage completions

GET/organization/usage/completions

Costs

$ openai admin:organization:usage costs

GET/organization/costs

Embeddings

$ openai admin:organization:usage embeddings

GET/organization/usage/embeddings

File search calls

$ openai admin:organization:usage file-search-calls

GET/organization/usage/file_search_calls

Images

$ openai admin:organization:usage images

GET/organization/usage/images

Moderations

$ openai admin:organization:usage moderations

GET/organization/usage/moderations

Vector stores

$ openai admin:organization:usage vector-stores

GET/organization/usage/vector_stores

Web search calls

$ openai admin:organization:usage web-search-calls

GET/organization/usage/web_search_calls

OrganizationUsers

Delete user

$ openai admin:organization:users delete

DELETE/organization/users/{user_id}

List users

$ openai admin:organization:users list

GET/organization/users

Retrieve user

$ openai admin:organization:users retrieve

GET/organization/users/{user_id}

Modify user

$ openai admin:organization:users update

POST/organization/users/{user_id}

ModelsExpand Collapse

organization_user: object { id, added_at, object, 13 more }

Represents an individual user within an organization.

OrganizationUsersRoles

Assign organization role to user

$ openai admin:organization:users:roles create

POST/organization/users/{user_id}/roles

Unassign organization role from user

$ openai admin:organization:users:roles delete

DELETE/organization/users/{user_id}/roles/{role_id}

List user organization role assignments

$ openai admin:organization:users:roles list

GET/organization/users/{user_id}/roles

Retrieve user organization role

$ openai admin:organization:users:roles retrieve

GET/organization/users/{user_id}/roles/{role_id}