NAME

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

DESCRIPTION

This document describes the API endpoint at /organization/projects/{project_id}/api_keys/{key_id}.

PATHS

DELETE /organization/projects/{project_id}/api_keys/{key_id}

Deletes an API key from the project.

Operation ID

delete-project-api-key

$client->delete-project-api-key( ... );

Parameters

• project_id (in path) (Required) - The ID of the project.

  Type: string

• key_id (in path) (Required) - The ID of the API key.

  Type: string

Responses

Status Code: 200

Project API key deleted successfully.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

Status Code: 400

Error response for various conditions.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
     "error" : null
  }

GET /organization/projects/{project_id}/api_keys/{key_id}

Retrieves an API key in the project.

Operation ID

retrieve-project-api-key

$client->retrieve-project-api-key( ... );

Parameters

• project_id (in path) (Required) - The ID of the project.

  Type: string

• key_id (in path) (Required) - The ID of the API key.

  Type: string

Responses

Status Code: 200

Project API key retrieved successfully.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
      "object": "organization.project.api_key",
      "redacted_value": "sk-abc...def",
      "name": "My API Key",
      "created_at": 1711471533,
      "id": "key_abc",
      "owner": {
          "type": "user",
          "user": {
              "object": "organization.project.user",
              "id": "user_abc",
              "name": "First Last",
              "email": "user@example.com",
              "role": "owner",
              "created_at": 1711471533
          }
      }
  }

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