Admin

Get Llm Info

GET/api/v1/admin/llms/info

Get License Info

GET/api/v1/admin/license/info

Get File Store Info

GET/api/v1/admin/filestores/info

Get Llamaextract Features

GET/api/v1/admin/llamaextract/features

Get Ocr Health

GET/api/v1/admin/ocr/statusz

ModelsExpand Collapse

AdminGetLlmsInfoResponse object { llm_info }

llm_info: map[map[object { internal_model_name, valid, error_message, last_validated } ]]

internal_model_name: string

valid: boolean

error_message: optional string

last_validated: optional string

AdminGetLicenseInfoResponse object { expires_at, status, message, scopes }

expires_at: string

License expiration date

formatdate-time

status: string

License validation status

message: optional string

License message

scopes: optional array of string

License scopes

AdminGetFilestoresInfoResponse object { status, available_buckets, unavailable_buckets }

status: "missing_buckets" or "missing_credentials" or "ok"

One of the following:

"missing_buckets"

"missing_credentials"

"ok"

available_buckets: optional map[string]

unavailable_buckets: optional map[string]

AdminGetLlamaextractFeaturesResponse object { available_modes, schema_generation }

available_modes: array of object { mode, parse_mode, status, 4 more }

mode: string

parse_mode: string

status: "available" or "unavailable"

One of the following:

"available"

"unavailable"

available_extract_models: optional array of string

available_parse_models: optional array of string

missing_extract_models: optional array of string

missing_parse_models: optional array of string

schema_generation: object { model, status }

model: string

status: "available" or "unavailable"

One of the following:

"available"

"unavailable"

AdminGetOcrStatusResponse object { status, device, error_message, 3 more }

Response model for OCR service health/GPU status.

status: "degraded" or "ok" or "unavailable"

One of the following:

"degraded"

"ok"

"unavailable"

device: optional string

error_message: optional string

gpu_available: optional boolean

gpu_device_count: optional number

gpu_device_name: optional string

AdminUsers

Get User Claims

GET/api/v1/admin/users/{user_id}/claims

Update User Claims

PATCH/api/v1/admin/users/{user_id}/claims

ModelsExpand Collapse

CustomClaims object { 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: optional boolean

Whether the user is allowed to delete organizations.

allowed_org_creation: optional boolean

Whether the user is allowed to create organizations.

api_datasource_access: optional boolean

Whether the user is allowed to access API data sources.

maximum_org_creation: optional number

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

UserClaims object { 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: optional boolean

Whether the user is allowed to delete organizations.

allowed_org_creation: optional boolean

Whether the user is allowed to create organizations.

api_datasource_access: optional boolean

Whether the user is allowed to access API data sources.

maximum_org_creation: optional number

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

GET/api/v1/admin/usage-metrics/aggregate

ModelsExpand Collapse

UsageMetricAggregateResponse object { buckets, group_by }

Response containing usage metrics aggregated by one or more dimensions.

buckets: array of object { dimensions, metric_count, total_credits, total_value }

The aggregation buckets, ordered by total credits descending

dimensions: map[string]

The dimension values that define this bucket

metric_count: number

Number of metric rows in this bucket

total_credits: number or 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 of "day" or "event_type" or "organization_id" or 2 more

The dimensions the metrics were grouped by

One of the following:

"day"

"event_type"

"organization_id"

"project_id"

"user_id"