Skip to content
LlamaCloud Admin API
Product Docs
API Reference
API Keys

Create Api Key

api_keys.create(APIKeyCreateParams**kwargs) -> APIKey
POST/api/v1/beta/api-keys

Create an API key.

Scope it to a project with project_id, which requires read access to that project; omit it for a key that reaches every project you can read. A project-scoped or agent key cannot create an API key. The response carries the secret in redacted_api_key, and only this once.

ParametersExpand Collapse
expires_at: Optional[Union[str, datetime, null]]

When the API key should expire. If not set, the key never expires.

formatdate-time
key_type: Optional[Literal["agent", "user"]]
One of the following:
"agent"
"user"
name: Optional[str]
project_id: Optional[str]

The project ID to associate with the API key.

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

Role capping what this key may do. A key can only ever be narrower than the user who created it, never broader. If not set, the key authorizes as its owner.

One of the following:
"admin"
"agent_viewer"
"viewer"
"viewer_v2"
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

Create Api Key

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
)
api_key = client.api_keys.create()
print(api_key.id)
{
  "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"
}
Returns Examples
{
  "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"
}