/ 
OpenAPI-Client-OpenAI-0.20
River stage zero No dependents
/ OpenAPI::Client::OpenAI::Path::organization-admin_api_keys-key_id

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

See the examples/ directory in the distribution for examples of how to use this.

DELETE /organization/admin_api_keys/{key_id}

Delete an organization admin API key

Delete the specified admin API key. =head3 Operation ID

admin-api-keys-delete

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

Parameters

  • key_id (in path) (Required) - No description available. Type: string

Responses

Status Code: 200

Confirmation that the API key was deleted.

Content Types:

  • application/json

    Example:

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

GET /organization/admin_api_keys/{key_id}

Retrieve a single organization API key

Get details for a specific organization API key by its ID. =head3 Operation ID

admin-api-keys-get

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

Parameters

  • key_id (in path) (Required) - No description available. Type: string

Responses

Status Code: 200

Details of the requested API key.

Content Types:

  • application/json

    Example:

    {
   "id" : "key_abc",
   "value" : "sk-admin-1234abcd",
   "owner" : {
      "id" : "sa_456",
      "type" : "service_account",
      "created_at" : 1711471533,
      "role" : "member",
      "name" : "My Service Account"
   },
   "name" : "Administration Key",
   "redacted_value" : "sk-admin...def",
   "created_at" : 1711471533,
   "object" : "organization.admin_api_key"
}

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.