Skip to content
  • Auto
  • Light
  • Dark

Update

Update Anthropic API Key
client.agents.evaluationMetrics.anthropic.keys.update(stringapiKeyUuid, KeyUpdateParams { api_key, api_key_uuid, name } body?, RequestOptionsoptions?): KeyUpdateResponse { api_key_info }
put/v2/gen-ai/anthropic/keys/{api_key_uuid}

To update an Anthropic API key, send a PUT request to /v2/gen-ai/anthropic/keys/{api_key_uuid}.

ParametersExpand Collapse
apiKeyUuid: string
body: KeyUpdateParams { api_key, api_key_uuid, name }
api_key?: string

Anthropic API key

api_key_uuid?: string

API key ID

name?: string

Name of the key

ReturnsExpand Collapse
KeyUpdateResponse { api_key_info }

UpdateAnthropicAPIKeyOutput is used to return the updated Anthropic API key.

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

Anthropic API Key Info

created_at?: string

Key creation date

formatdate-time
created_by?: string

Created by user id from DO

formatuint64
deleted_at?: string

Key deleted date

formatdate-time
name?: string

Name

updated_at?: string

Key last updated date

formatdate-time
uuid?: string

Uuid

Update Anthropic API Key
import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const key = await client.agents.evaluationMetrics.anthropic.keys.update(
  '"123e4567-e89b-12d3-a456-426614174000"',
);

console.log(key.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",
    "updated_at": "2023-01-01T00:00:00Z",
    "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",
    "updated_at": "2023-01-01T00:00:00Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}