Skip to content
LlamaCloud Admin API
Product Docs
API Reference

Admin

Get Llm Info
client.admin.getLlmsInfo(RequestOptionsoptions?): AdminGetLlmsInfoResponse { llm_info }
GET/api/v1/admin/llms/info
Get License Info
client.admin.getLicenseInfo(AdminGetLicenseInfoParams { include_scopes } query?, RequestOptionsoptions?): AdminGetLicenseInfoResponse { expires_at, status, message, scopes }
GET/api/v1/admin/license/info
Get File Store Info
client.admin.getFilestoresInfo(RequestOptionsoptions?): AdminGetFilestoresInfoResponse { status, available_buckets, unavailable_buckets }
GET/api/v1/admin/filestores/info
Get Llamaextract Features
client.admin.getLlamaextractFeatures(RequestOptionsoptions?): AdminGetLlamaextractFeaturesResponse { available_modes, schema_generation }
GET/api/v1/admin/llamaextract/features
Get Ocr Health
client.admin.getOcrStatus(RequestOptionsoptions?): AdminGetOcrStatusResponse { status, device, error_message, 3 more }
GET/api/v1/admin/ocr/statusz
ModelsExpand Collapse
AdminGetLlmsInfoResponse { llm_info }
llm_info: Record<string, Record<string, ValidationStatus>>
internal_model_name: string | null
valid: boolean
error_message?: string | null
last_validated?: string
AdminGetLicenseInfoResponse { expires_at, status, message, scopes }
expires_at: string

License expiration date

formatdate-time
status: string

License validation status

message?: string | null

License message

scopes?: Array<string> | null

License scopes

AdminGetFilestoresInfoResponse { status, available_buckets, unavailable_buckets }
status: "missing_buckets" | "missing_credentials" | "ok"
One of the following:
"missing_buckets"
"missing_credentials"
"ok"
available_buckets?: Record<string, string>
unavailable_buckets?: Record<string, string>
AdminGetLlamaextractFeaturesResponse { available_modes, schema_generation }
available_modes: Array<AvailableMode>
mode: string
parse_mode: string
status: "available" | "unavailable"
One of the following:
"available"
"unavailable"
available_extract_models?: Array<string>
available_parse_models?: Array<string>
missing_extract_models?: Array<string>
missing_parse_models?: Array<string>
schema_generation: SchemaGeneration { model, status }
model: string
status: "available" | "unavailable"
One of the following:
"available"
"unavailable"
AdminGetOcrStatusResponse { status, device, error_message, 3 more }

Response model for OCR service health/GPU status.

status: "degraded" | "ok" | "unavailable"
One of the following:
"degraded"
"ok"
"unavailable"
device?: string
error_message?: string | null
gpu_available?: boolean
gpu_device_count?: number | null
gpu_device_name?: string | null

AdminUsers

Get User Claims
client.admin.users.getClaims(stringuserID, RequestOptionsoptions?): UserClaims { claims, user_id }
GET/api/v1/admin/users/{user_id}/claims
Update User Claims
client.admin.users.updateClaims(stringuserID, UserUpdateClaimsParams { remove_claims, set_claims } body, RequestOptionsoptions?): UserClaims { claims, user_id }
PATCH/api/v1/admin/users/{user_id}/claims
ModelsExpand Collapse
CustomClaims { allow_org_deletion, allowed_org_creation, api_datasource_access, maximum_org_creation }

Custom claims that dictate various limits or allowed behaviors. Currently these claims reside at a per user level. Claims may expand to a per organization level or project in the future.

allow_org_deletion?: boolean

Whether the user is allowed to delete organizations.

allowed_org_creation?: boolean

Whether the user is allowed to create organizations.

api_datasource_access?: boolean

Whether the user is allowed to access API data sources.

maximum_org_creation?: number | null

Cap on how many organizations this user may create. None means unlimited. Only enforced when allowed_org_creation is True.

UserClaims { claims, user_id }

A user’s fully resolved custom claims after applying system defaults.

claims: CustomClaims { allow_org_deletion, allowed_org_creation, api_datasource_access, maximum_org_creation }

The user’s resolved custom claims.

allow_org_deletion?: boolean

Whether the user is allowed to delete organizations.

allowed_org_creation?: boolean

Whether the user is allowed to create organizations.

api_datasource_access?: boolean

Whether the user is allowed to access API data sources.

maximum_org_creation?: number | null

Cap on how many organizations this user may create. None means unlimited. Only enforced when allowed_org_creation is True.

user_id: string

The user ID the claims belong to.

AdminUsage Metrics

Aggregate Usage Metrics
client.admin.usageMetrics.aggregate(UsageMetricAggregateParams { day_on_or_after, day_on_or_before, group_by, 4 more } query, RequestOptionsoptions?): UsageMetricAggregateResponse { buckets, group_by }
GET/api/v1/admin/usage-metrics/aggregate
ModelsExpand Collapse
UsageMetricAggregateResponse { buckets, group_by }

Response containing usage metrics aggregated by one or more dimensions.

buckets: Array<Bucket>

The aggregation buckets, ordered by total credits descending

dimensions: Record<string, string>

The dimension values that define this bucket

metric_count: number

Number of metric rows in this bucket

total_credits: number | string

Total credits consumed by metrics in this bucket

One of the following:
number
string
total_value: number

Total of the metric value field in this bucket

group_by: Array<"day" | "event_type" | "organization_id" | 2 more>

The dimensions the metrics were grouped by

One of the following:
"day"
"event_type"
"organization_id"
"project_id"
"user_id"