Skip to content
  • Auto
  • Light
  • Dark

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

Api key infos

Links to other pages

meta: optional APIMeta

Meta information about the data set

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
  }
}