List

API Reference

Agents

API Keys

List Agent API Keys

agents.api_keys.list(stragent_uuid, APIKeyListParams**kwargs) -> APIKeyListResponse

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.

ParametersExpand Collapse

agent_uuid: str

page: Optional[int]

Page number.

per_page: Optional[int]

Items per page.

ReturnsExpand Collapse

class APIKeyListResponse: …

api_key_infos: Optional[List[APIAgentAPIKeyInfo]]

Api key infos

created_at: Optional[datetime]

Creation date

formatdate-time

created_by: Optional[str]

Created by

formatuint64

deleted_at: Optional[datetime]

Deleted date

formatdate-time

name: Optional[str]

Name

secret_key: Optional[str]

uuid: Optional[str]

Uuid

links: Optional[APILinks]

Links to other pages

meta: Optional[APIMeta]

Meta information about the data set

HTTPPython

from gradient import Gradient

client = Gradient()
api_keys = client.agents.api_keys.list(
    agent_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
)
print(api_keys.api_key_infos)

200 example

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

200 example

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