Skip to content
Primary navigation

Delete admin API key

client.admin.organization.adminAPIKeys.delete(stringkeyID, RequestOptionsoptions?): AdminAPIKeyDeleteResponse { id, deleted, object }
DELETE/organization/admin_api_keys/{key_id}

Delete an organization admin API key

ParametersExpand Collapse
keyID: string

The ID of the API key to be deleted.

ReturnsExpand Collapse
AdminAPIKeyDeleteResponse { id, deleted, object }
id: string
deleted: boolean
object: "organization.admin_api_key.deleted"

Delete admin API key

import OpenAI from 'openai';

const client = new OpenAI({
  adminAPIKey: process.env['OPENAI_ADMIN_KEY'], // This is the default and can be omitted
});

const adminAPIKey = await client.admin.organization.adminAPIKeys.delete('key_id');

console.log(adminAPIKey.id);
{
  "id": "key_abc",
  "object": "organization.admin_api_key.deleted",
  "deleted": true
}
Returns Examples
{
  "id": "key_abc",
  "object": "organization.admin_api_key.deleted",
  "deleted": true
}