List Api Keys

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.

Query ParametersExpand Collapse

expand: optional array of string

key_type: optional "agent" or "user"

One of the following:

"agent"

"user"

name: optional string

page_size: optional number

page_token: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

items: array of APIKey { id, redacted_api_key, user_id, 8 more }

The list of items.

id: string

Unique identifier

formatuuid

redacted_api_key: string

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

user_id: string

created_at: optional string

Creation datetime

formatdate-time

expires_at: optional string

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

formatdate-time

key_type: optional "agent" or "user"

One of the following:

"agent"

"user"

metadata: optional map[unknown]

name: optional string

project_id: optional string

role: optional "admin" or "agent_viewer" or "viewer" or "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 string

Update datetime

formatdate-time

next_page_token: optional string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_size: optional number

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

List Api Keys

curl https://api.cloud.llamaindex.ai/api/v1/beta/api-keys \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"

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