Skip to content
Gradient SDK Docs
  • Auto
  • Light
  • Dark

List

List Model API Keys
inference.api_keys.list(APIKeyListParams**kwargs) -> api_key_infoslistlinksAPILinksmetaAPIMetaAPIKeyListResponse
get/v2/gen-ai/models/api_keys

To list all model API keys, send a GET request to /v2/gen-ai/models/api_keys.

Parameters
pageint
optional

Page number.

per_pageint
optional

Items per page.

Returns
APIKeyListResponseclass
Hide ParametersShow Parameters
api_key_infoslist
optional
Optional[List[created_atdatetimecreated_bystrdeleted_atdatetimenamestrsecret_keystruuidstrAPIModelAPIKeyInfo]]

Api key infos

Hide ParametersShow Parameters
created_atdatetime
optional

Creation date

formatdate-time
created_bystr
optional

Created by

formatuint64
deleted_atdatetime
optional

Deleted date

formatdate-time
namestr
optional

Name

secret_keystr
optional
uuidstr
optional

Uuid

metaAPIMeta
optional

Meta information about the data set

from do_gradientai import GradientAI

client = GradientAI()
api_keys = client.inference.api_keys.list()
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
  }
}