Skip to content
Primary navigation

Create admin API key

admin.organization.admin_api_keys.create(**kwargs) -> AdminAPIKeyCreateResponse { value }
POST/organization/admin_api_keys

Create an organization admin API key

ParametersExpand Collapse
name: String
ReturnsExpand Collapse
class AdminAPIKeyCreateResponse { value }

Represents an individual Admin API key in an org.

value: String

The value of the API key. Only shown on create.

Create admin API key

require "openai"

openai = OpenAI::Client.new(admin_api_key: "My Admin API Key")

admin_api_key = openai.admin.organization.admin_api_keys.create(name: "New Admin Key")

puts(admin_api_key)
{
  "object": "organization.admin_api_key",
  "id": "key_xyz",
  "name": "New Admin Key",
  "redacted_value": "sk-admin...xyz",
  "created_at": 1711471533,
  "last_used_at": 1711471534,
  "owner": {
    "type": "user",
    "object": "organization.user",
    "id": "user_123",
    "name": "John Doe",
    "created_at": 1711471533,
    "role": "owner"
  },
  "value": "sk-admin-1234abcd"
}
Returns Examples
{
  "object": "organization.admin_api_key",
  "id": "key_xyz",
  "name": "New Admin Key",
  "redacted_value": "sk-admin...xyz",
  "created_at": 1711471533,
  "last_used_at": 1711471534,
  "owner": {
    "type": "user",
    "object": "organization.user",
    "id": "user_123",
    "name": "John Doe",
    "created_at": 1711471533,
    "role": "owner"
  },
  "value": "sk-admin-1234abcd"
}