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

List

API Reference
Agents
Evaluation Metrics
OpenAI
Keys
List OpenAI API Keys
agents.evaluation_metrics.openai.keys.list(KeyListParams**kwargs) -> KeyListResponse
get/v2/gen-ai/openai/keys

To list all OpenAI API keys, send a GET request to /v2/gen-ai/openai/keys.

ParametersExpand Collapse
page: Optional[int]

Page number.

per_page: Optional[int]

Items per page.

ReturnsExpand Collapse
class KeyListResponse: …

ListOpenAIAPIKeysOutput is used to return the list of OpenAI API keys for a specific agent.

api_key_infos: Optional[List[APIOpenAIAPIKeyInfo]]

Api key infos

created_at: Optional[datetime]

Key creation date

formatdate-time
created_by: Optional[str]

Created by user id from DO

formatuint64
deleted_at: Optional[datetime]

Key deleted date

formatdate-time
models: Optional[List[APIAgentModel]]

Models supported by the openAI api key

agreement: Optional[APIAgreement]

Agreement Description

description: Optional[str]
name: Optional[str]
url: Optional[str]
uuid: Optional[str]
created_at: Optional[datetime]

Creation date / time

formatdate-time
inference_name: Optional[str]

Internally used name

inference_version: Optional[str]

Internally used version

is_foundational: Optional[bool]

True if it is a foundational model provided by do

metadata: Optional[object]

Additional meta data

name: Optional[str]

Name of the model

parent_uuid: Optional[str]

Unique id of the model, this model is based on

provider: Optional[Literal["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: Optional[datetime]

Last modified

formatdate-time
upload_complete: Optional[bool]

Model has been fully uploaded

url: Optional[str]

Download url

usecases: Optional[List[Literal["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: Optional[str]

Unique id

version: Optional[APIModelVersion]

Version Information about a Model

major: Optional[int]

Major version number

formatint64
minor: Optional[int]

Minor version number

formatint64
patch: Optional[int]

Patch version number

formatint64
name: Optional[str]

Name

updated_at: Optional[datetime]

Key last updated date

formatdate-time
uuid: Optional[str]

Uuid

Links to other pages

Information about how to reach other pages

First page

Last page

Next page

Previous page

meta: Optional[APIMeta]

Meta information about the data set

page: Optional[int]

The current page

formatint64
pages: Optional[int]

Total number of pages

formatint64
total: Optional[int]

Total amount of items over all pages

formatint64
List OpenAI API Keys
  • http
  • typescript
  • python
from gradient import Gradient

client = Gradient()
keys = client.agents.evaluation_metrics.openai.keys.list()
print(keys.api_key_infos)
{
  "api_key_infos": [
    {
      "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"
    }
  ],
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}
Returns Examples
{
  "api_key_infos": [
    {
      "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"
    }
  ],
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  }
}