List Api Keys

api_keys.list() -> SyncPaginatedCursor[APIKey]

GET/api/v1/beta/api-keys

List API keys.

Name a project_id to list every key on that project, which its members share; naming one you cannot read is a 404. Omit it to list your own. A project-scoped key sees only its own project either way.

ParametersExpand Collapse

expand: Optional[Sequence[str]]

key_type: Optional[Literal["agent", "user"]]

One of the following:

"agent"

"user"

name: Optional[str]

page_size: Optional[int]

page_token: Optional[str]

project_id: Optional[str]

ReturnsExpand Collapse

class APIKey: …

Schema for an API Key.

id: str

Unique identifier

formatuuid

redacted_api_key: str

The key with its middle masked, except on the create response, which returns the full secret once and never again.

user_id: str

created_at: Optional[datetime]

Creation datetime

formatdate-time

expires_at: Optional[datetime]

When the API key expires. Null if the key never expires.

formatdate-time

key_type: Optional[Literal["agent", "user"]]

One of the following:

"agent"

"user"

metadata: Optional[Dict[str, object]]

name: Optional[str]

project_id: Optional[str]

role: Optional[Literal["admin", "agent_viewer", "viewer", "viewer_v2"]]

Role capping what this key may do. Null if the key authorizes as its owner.

One of the following:

"admin"

"agent_viewer"

"viewer"

"viewer_v2"

updated_at: Optional[datetime]

Update datetime

formatdate-time

List Api Keys

import os
from llama_cloud_admin import LlamaCloudAdmin

client = LlamaCloudAdmin(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
page = client.api_keys.list()
page = page.items[0]
print(page.id)

{
  "items": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "redacted_api_key": "redacted_api_key",
      "user_id": "user_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "key_type": "agent",
      "metadata": {
        "foo": "bar"
      },
      "name": "name",
      "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "role": "admin",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

{
  "items": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "redacted_api_key": "redacted_api_key",
      "user_id": "user_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "key_type": "agent",
      "metadata": {
        "foo": "bar"
      },
      "name": "name",
      "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "role": "admin",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}