NAME

OpenAPI::Client::OpenAI::Path::organization-admin_api_keys-key_id - Documentation for the /organization/admin_api_keys/{key_id} path.

DESCRIPTION

This document describes the API endpoint at /organization/admin_api_keys/{key_id}.

PATHS

DELETE /organization/admin_api_keys/{key_id}

Delete admin API key

Delete an organization admin API key

Operation ID

admin-api-keys-delete

$client->admin-api-keys-delete( ... );

Parameters

• key_id (in path) (Required) -

  Type: string

Responses

Status Code: 200

Confirmation that the API key was deleted.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
     "deleted" : true,
     "id" : "key_abc",
     "object" : "organization.admin_api_key.deleted"
  }

GET /organization/admin_api_keys/{key_id}

Retrieve admin API key

Retrieve a single organization API key

Operation ID

admin-api-keys-get

$client->admin-api-keys-get( ... );

Parameters

• key_id (in path) (Required) -

  Type: string

Responses

Status Code: 200

Details of the requested API key.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
    "object": "organization.admin_api_key",
    "id": "key_abc",
    "name": "Main 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"
    }
  }

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.

cpanm OpenAPI::Client::OpenAI

perl -MCPAN -e shell
install OpenAPI::Client::OpenAI