Sign in
DigitalOcean-public.v2-new_GradientAI Platform

List Agent API Keys

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

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

Path parameters

agent_uuidstring required

Agent id

Query parameters

pageinteger

Page number.

per_pageinteger

Items per page.

Response

A successful response.

Example response

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

Changes

Changed in 4 of the 8 revisions of this API.2330

  • cb3bf9b214592See the full diff
    • ○

      api tag DigitalOcean-public.v2-new_GradientAI Platform added

      api-tag-added

    • ○

      api tag GradientAI Platform removed

      api-tag-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f8e8c290636c10See the full diff
    • ○

      api operation id list_agent_api_keys removed and replaced with genai_list_agent_api_keys

      api-operation-id-removed

    • ○

      the endpoint scheme security bearer_auth was added to the API

      api-security-added

    • ○

      api tag GradientAI Platform added

      api-tag-added

    • ○

      api tag GenAIAPI removed

      api-tag-removed

    • ○

      for the query request parameter page, the type/format was generalized from integer/int64 to integer/

      request-parameter-type-generalized

    • ○

      for the query request parameter per_page, the type/format was generalized from integer/int64 to integer/

      request-parameter-type-generalized

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

    This revision also has 70 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5fc9af728e82238See the full diff
    • ▲

      for the query request parameter page, the type/format was changed from integer/ to integer/int64

      request-parameter-type-changed

    • ▲

      for the query request parameter per_page, the type/format was changed from integer/ to integer/int64

      request-parameter-type-changed

    • ●

      the optional response header ratelimit-limit removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header ratelimit-remaining removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header ratelimit-reset removed for the status 200

      optional-response-header-removed

    • ○

      api operation id genai_list_agent_api_keys removed and replaced with list_agent_api_keys

      api-operation-id-removed

    • ○

      the endpoint scheme security bearer_auth was removed from the API

      api-security-removed

    • ○

      api tag GenAIAPI added

      api-tag-added

    • ○

      api tag GradientAI Platform removed

      api-tag-removed

    • ○

      removed the non-success response with the status 401

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 404

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 429

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

    This revision also has 436 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f8e8c290636c10See the full diff
    • ○

      api operation id list_agent_api_keys removed and replaced with genai_list_agent_api_keys

      api-operation-id-removed

    • ○

      the endpoint scheme security bearer_auth was added to the API

      api-security-added

    • ○

      api tag GradientAI Platform added

      api-tag-added

    • ○

      api tag GenAIAPI removed

      api-tag-removed

    • ○

      for the query request parameter page, the type/format was generalized from integer/int64 to integer/

      request-parameter-type-generalized

    • ○

      for the query request parameter per_page, the type/format was generalized from integer/int64 to integer/

      request-parameter-type-generalized

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

    This revision also has 70 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog