Delete an organization admin API key | OpenAI API (unofficial showcase)

1 parameter

key_idstringrequired

The identifier of the API key to delete.

3 status codes

200Returns a deletion confirmation containing the API key identifier, object type, and a `deleted` flag.

idstringrequired

objectstringrequired

Allowed:organization.admin_api_key.deleted

deletedbooleanrequired

403Returned when the caller does not have permission to perform this operation.

errorobjectrequired

Details about the permission error.

404Returned when the API key is not found or is not available to the organization.

errorobjectrequired

Error handling

A 403 is returned when the caller does not have permission to delete the API key. A 404 is returned when the key is not found or is unavailable to the organization. The key_id path parameter must identify an API key available to the organization.

import { Client } from "@octridev/openai";

const client = new Client({
  baseUrl: "https://api.openai.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.adminApiKeys.delete({ keyId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

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

Request

Response

Errors