List

List Agent API Keys

get/v2/gen-ai/agents/{agent_uuid}/api_keys

To list all agent API keys, send a GET request to /v2/gen-ai/agents/{agent_uuid}/api_keys.

Path ParametersExpand Collapse

agent_uuid: string

Query ParametersExpand Collapse

page: optional number

Page number.

per_page: optional number

Items per page.

ReturnsExpand Collapse

api_key_infos: optional array of APIAgentAPIKeyInfo { created_at, created_by, deleted_at, 3 more }

Api key infos

created_at: optional string

Creation date

formatdate-time

created_by: optional string

Created by

formatuint64

deleted_at: optional string

Deleted date

formatdate-time

name: optional string

Name

secret_key: optional string

uuid: optional string

Uuid

links: optional APILinks { pages }

Links to other pages

pages: optional object { first, last, next, previous }

Information about how to reach other pages

first: optional string

First page

last: optional string

Last page

next: optional string

previous: optional string

meta: optional APIMeta { page, pages, total }

Meta information about the data set

page: optional number

The current page

formatint64

pages: optional number

Total number of pages

formatint64

total: optional number

Total amount of items over all pages

formatint64

List Agent API Keys

curl https://api.digitalocean.com/v2/gen-ai/agents/$AGENT_UUID/api_keys \
    -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"

{
  "api_key_infos": [
    {
      "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"
    }
  ],
  "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",
      "name": "example name",
      "secret_key": "example string",
      "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
  }
}