API Reference

Inference

API Keys

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update API Key for a Model

client.inference.apiKeys.update(stringapiKeyUuid, APIKeyUpdateParams { api_key_uuid, name } body?, RequestOptionsoptions?): APIKeyUpdateResponse { api_key_info }

put/v2/gen-ai/models/api_keys/{api_key_uuid}

To update a model API key, send a PUT request to /v2/gen-ai/models/api_keys/{api_key_uuid}.

ParametersExpand Collapse

apiKeyUuid: string

body: APIKeyUpdateParams { api_key_uuid, name }

api_key_uuid?: string

API key ID

name?: string

Name

ReturnsExpand Collapse

APIKeyUpdateResponse { api_key_info }

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

Model 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

Update API Key for a Model

TypeScript

HTTP

TypeScript

Python

Go

import Gradient from '@digitalocean/gradient';

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

const apiKey = await client.inference.apiKeys.update('"123e4567-e89b-12d3-a456-426614174000"');

console.log(apiKey.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"
  }
}