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.

Retrieve admin API key

admin.organization.admin_api_keys.retrieve() -> AdminAPIKey

GET/organization/admin_api_keys/{key_id}

Retrieve a single organization API key

ParametersExpand Collapse

key_id: str

The ID of the API key.

ReturnsExpand Collapse

class AdminAPIKey: …

Represents an individual Admin API key in an org.

id: str

The identifier, which can be referenced in API endpoints

created_at: int

The Unix timestamp (in seconds) of when the API key was created

formatunixtime

expires_at: Optional[int]

The Unix timestamp (in seconds) of when the API key expires

formatunixtime

object: Literal["organization.admin_api_key"]

The object type, which is always organization.admin_api_key

owner: Owner

View schema details

redacted_value: str

The redacted value of the API key

last_used_at: Optional[int]

The Unix timestamp (in seconds) of when the API key was last used

formatunixtime

name: Optional[str]

The name of the API key

Retrieve admin API key

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
admin_api_key = client.admin.organization.admin_api_keys.retrieve(
    "key_id",
)
print(admin_api_key.id)

{
  "object": "organization.admin_api_key",
  "id": "key_abc",
  "name": "Main Admin Key",
  "redacted_value": "sk-admin...xyz",
  "created_at": 1711471533,
  "expires_at": null,
  "last_used_at": 1711471534,
  "owner": {
    "type": "user",
    "object": "organization.user",
    "id": "user_123",
    "name": "John Doe",
    "created_at": 1711471533,
    "role": "owner"
  }
}

Returns Examples

{
  "object": "organization.admin_api_key",
  "id": "key_abc",
  "name": "Main Admin Key",
  "redacted_value": "sk-admin...xyz",
  "created_at": 1711471533,
  "expires_at": null,
  "last_used_at": 1711471534,
  "owner": {
    "type": "user",
    "object": "organization.user",
    "id": "user_123",
    "name": "John Doe",
    "created_at": 1711471533,
    "role": "owner"
  }
}