Delete API Key for an Agent

client.agents.apiKeys.delete(, , ?): APIKeyDeleteResponse { api_key_info }

delete/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}

To delete an API key for an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.

ParametersExpand Collapse

apiKeyUuid: string

params: APIKeyDeleteParams { agent_uuid }

agent_uuid: string

A unique identifier for your agent.

ReturnsExpand Collapse

APIKeyDeleteResponse { api_key_info }

api_key_info?: APIAgentAPIKeyInfo { created_at, created_by, deleted_at, 3 more }

Agent API Key Info

created_at?: string

Creation date

formatdate-time

created_by?: string

Created by

formatuint64

deleted_at?: string

Deleted date

formatdate-time

name?: string

Name

secret_key?: string

uuid?: string

Uuid

Delete API Key for an Agent

import Gradient from '@digitalocean/gradient';

const client = new Gradient({
  accessToken: 'My Access Token',
});

const apiKey = await client.agents.apiKeys.delete('"123e4567-e89b-12d3-a456-426614174000"', {
  agent_uuid: '"123e4567-e89b-12d3-a456-426614174000"',
});

console.log(apiKey.api_key_info);

{
  "api_key_info": {
    "created_at": "2023-01-01T00:00:00Z",
    "created_by": "12345",
    "deleted_at": "2023-01-01T00:00:00Z",
    "name": "example name",
    "secret_key": "example string",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Returns Examples

{
  "api_key_info": {
    "created_at": "2023-01-01T00:00:00Z",
    "created_by": "12345",
    "deleted_at": "2023-01-01T00:00:00Z",
    "name": "example name",
    "secret_key": "example string",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}