Skip to content
DigitalOcean Gradient™ AI Agentic Cloud SDK Docs
  • Auto
  • Light
  • Dark

Create

API Reference
Agents
Evaluation Metrics
OpenAI
Keys
Create OpenAI API Key
client.agents.evaluationMetrics.openai.keys.create(KeyCreateParams { api_key, name } body?, RequestOptionsoptions?): KeyCreateResponse { api_key_info }
post/v2/gen-ai/openai/keys

To create an OpenAI API key, send a POST request to /v2/gen-ai/openai/keys.

ParametersExpand Collapse
body: KeyCreateParams { api_key, name }
api_key?: string

OpenAI API key

name?: string

Name of the key

ReturnsExpand Collapse
KeyCreateResponse { api_key_info }

CreateOpenAIAPIKeyOutput is used to return the newly created OpenAI API key.

api_key_info?: APIOpenAIAPIKeyInfo { created_at, created_by, deleted_at, 4 more }

OpenAI 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
models?: Array<APIAgentModel { agreement, created_at, inference_name, 12 more } >

Models supported by the openAI api key

agreement?: APIAgreement { description, name, url, uuid }

Agreement Description

description?: string
name?: string
url?: string
uuid?: string
created_at?: string

Creation date / time

formatdate-time
inference_name?: string

Internally used name

inference_version?: string

Internally used version

is_foundational?: boolean

True if it is a foundational model provided by do

metadata?: unknown

Additional meta data

name?: string

Name of the model

parent_uuid?: string

Unique id of the model, this model is based on

provider?: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"
Accepts one of the following:
"MODEL_PROVIDER_DIGITALOCEAN"
"MODEL_PROVIDER_ANTHROPIC"
"MODEL_PROVIDER_OPENAI"
updated_at?: string

Last modified

formatdate-time
upload_complete?: boolean

Model has been fully uploaded

url?: string

Download url

usecases?: Array<"MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | 4 more>

Usecases of the model

Accepts one of the following:
"MODEL_USECASE_UNKNOWN"
"MODEL_USECASE_AGENT"
"MODEL_USECASE_FINETUNED"
"MODEL_USECASE_KNOWLEDGEBASE"
"MODEL_USECASE_GUARDRAIL"
"MODEL_USECASE_REASONING"
"MODEL_USECASE_SERVERLESS"
uuid?: string

Unique id

version?: APIModelVersion { major, minor, patch }

Version Information about a Model

major?: number

Major version number

formatint64
minor?: number

Minor version number

formatint64
patch?: number

Patch version number

formatint64
name?: string

Name

updated_at?: string

Key last updated date

formatdate-time
uuid?: string

Uuid

Create OpenAI API Key
  • http
  • typescript
  • python
import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const key = await client.agents.evaluationMetrics.openai.keys.create();

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",
    "models": [
      {
        "agreement": {
          "description": "example string",
          "name": "example name",
          "url": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        },
        "created_at": "2023-01-01T00:00:00Z",
        "inference_name": "example name",
        "inference_version": "example string",
        "is_foundational": true,
        "metadata": {},
        "name": "example name",
        "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "provider": "MODEL_PROVIDER_DIGITALOCEAN",
        "updated_at": "2023-01-01T00:00:00Z",
        "upload_complete": true,
        "url": "example string",
        "usecases": [
          "MODEL_USECASE_AGENT",
          "MODEL_USECASE_GUARDRAIL"
        ],
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "version": {
          "major": 123,
          "minor": 123,
          "patch": 123
        }
      }
    ],
    "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",
    "models": [
      {
        "agreement": {
          "description": "example string",
          "name": "example name",
          "url": "example string",
          "uuid": "123e4567-e89b-12d3-a456-426614174000"
        },
        "created_at": "2023-01-01T00:00:00Z",
        "inference_name": "example name",
        "inference_version": "example string",
        "is_foundational": true,
        "metadata": {},
        "name": "example name",
        "parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "provider": "MODEL_PROVIDER_DIGITALOCEAN",
        "updated_at": "2023-01-01T00:00:00Z",
        "upload_complete": true,
        "url": "example string",
        "usecases": [
          "MODEL_USECASE_AGENT",
          "MODEL_USECASE_GUARDRAIL"
        ],
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "version": {
          "major": 123,
          "minor": 123,
          "patch": 123
        }
      }
    ],
    "name": "example name",
    "updated_at": "2023-01-01T00:00:00Z",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}