Skip to content
  • Auto
  • Light
  • Dark

List

List OpenAI API Keys
get/v2/gen-ai/openai/keys

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

Query Parameters
pagenumber
optional

Page number.

per_pagenumber
optional

Items per page.

Returns
api_key_infosarray of created_atstringcreated_bystringdeleted_atstringmodelsarray of APIAgentModelnamestringupdated_atstringuuidstringAPIOpenAIAPIKeyInfo
optional

Api key infos

metapagenumberpagesnumbertotalnumberAPIMeta
optional

Meta information about the data set

curl https://api.digitalocean.com//v2/gen-ai/openai/keys \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"
200 Example
{
  "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
  }
}