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

NAME

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

DESCRIPTION

This document describes the API endpoint at /organization/admin_api_keys.

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

GET /organization/admin_api_keys

List organization API keys

Retrieve a paginated list of organization admin API keys. =head3 Operation ID

admin-api-keys-list

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

Parameters

  • after (in query) (Optional) - No description available. Type: string

  • order (in query) (Optional) - No description available. Type: string

    Possible values: asc desc

    Default: asc

  • limit (in query) (Optional) - No description available. Type: integer

    Default: 20

Responses

Status Code: 200

A list of organization API keys.

Content Types:

  • application/json

    Example:

    {
   "object" : "list",
   "data" : [
      {
         "owner" : {
            "id" : "sa_456",
            "type" : "service_account",
            "role" : "member",
            "name" : "My Service Account",
            "created_at" : 1711471533
         },
         "name" : "Administration Key",
         "redacted_value" : "sk-admin...def",
         "object" : "organization.admin_api_key",
         "created_at" : 1711471533,
         "id" : "key_abc",
         "value" : "sk-admin-1234abcd"
      }
   ],
   "has_more" : false,
   "first_id" : "key_abc",
   "last_id" : "key_xyz"
}

POST /organization/admin_api_keys

Create an organization admin API key

Create a new admin-level API key for the organization. =head3 Operation ID

admin-api-keys-create

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

Request Body

Content Type: application/json

Example:

{
   "name" : "New Admin Key"
}

Responses

Status Code: 200

The newly created admin API key.

Content Types:

  • application/json

    Example:

    {
   "value" : "sk-admin-1234abcd",
   "id" : "key_abc",
   "name" : "Administration Key",
   "owner" : {
      "created_at" : 1711471533,
      "name" : "My Service Account",
      "role" : "member",
      "id" : "sa_456",
      "type" : "service_account"
   },
   "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.