List Api Keys

ApiKeyListPage apiKeys().list(, )

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

ApiKeyListParams params

Optional<List<String>> expand

Optional<KeyType> keyType

AGENT("agent")

USER("user")

Optional<String> name

Optional<Long> pageSize

Optional<String> pageToken

Optional<String> projectId

ReturnsExpand Collapse

class ApiKey:

Schema for an API Key.

String id

Unique identifier

formatuuid

String redactedApiKey

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

String userId

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<LocalDateTime> expiresAt

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

formatdate-time

Optional<KeyType> keyType

One of the following:

AGENT("agent")

USER("user")

Optional<Metadata> metadata

Optional<String> name

Optional<String> projectId

Optional<Role> role

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

One of the following:

ADMIN("admin")

AGENT_VIEWER("agent_viewer")

VIEWER("viewer")

VIEWER_V2("viewer_v2")

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

List Api Keys

package ai.llamaindex.llamacloudadmin.example;

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import ai.llamaindex.llamacloudadmin.models.apikeys.ApiKeyListPage;
import ai.llamaindex.llamacloudadmin.models.apikeys.ApiKeyListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.fromEnv();

        ApiKeyListPage page = client.apiKeys().list();
    }
}

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