Regenerate

API Reference

Agents

API Keys

Regenerate API Key for an Agent

client.agents.apiKeys.regenerate(stringapiKeyUuid, APIKeyRegenerateParams { agent_uuid } params, RequestOptionsoptions?): APIKeyRegenerateResponse { api_key_info }

put/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate

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

ParametersExpand Collapse

apiKeyUuid: string

params: APIKeyRegenerateParams { agent_uuid }

agent_uuid: string

Agent id

ReturnsExpand Collapse

APIKeyRegenerateResponse { 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

Regenerate API Key for an Agent

typescript

• http
• typescript
• python

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

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

console.log(response.api_key_info);

200 example

{
  "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

200 example

{
  "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"
  }
}