Admin

Get Llm Info

admin.get_llms_info() -> AdminGetLlmsInfoResponse

GET/api/v1/admin/llms/info

Get License Info

admin.get_license_info() -> AdminGetLicenseInfoResponse

GET/api/v1/admin/license/info

Get File Store Info

admin.get_filestores_info() -> AdminGetFilestoresInfoResponse

GET/api/v1/admin/filestores/info

Get Llamaextract Features

admin.get_llamaextract_features() -> AdminGetLlamaextractFeaturesResponse

GET/api/v1/admin/llamaextract/features

Get Ocr Health

admin.get_ocr_status() -> AdminGetOcrStatusResponse

GET/api/v1/admin/ocr/statusz

ModelsExpand Collapse

class AdminGetLlmsInfoResponse: …

llm_info: Dict[str, Dict[str, LlmInfoLlmInfoItem]]

internal_model_name: Optional[str]

valid: bool

error_message: Optional[str]

last_validated: Optional[datetime]

class AdminGetLicenseInfoResponse: …

expires_at: datetime

License expiration date

formatdate-time

status: str

License validation status

message: Optional[str]

License message

scopes: Optional[List[str]]

License scopes

class AdminGetFilestoresInfoResponse: …

status: Literal["missing_buckets", "missing_credentials", "ok"]

One of the following:

"missing_buckets"

"missing_credentials"

"ok"

available_buckets: Optional[Dict[str, str]]

unavailable_buckets: Optional[Dict[str, str]]

class AdminGetLlamaextractFeaturesResponse: …

available_modes: List[AvailableMode]

mode: str

parse_mode: str

status: Literal["available", "unavailable"]

One of the following:

"available"

"unavailable"

available_extract_models: Optional[List[str]]

available_parse_models: Optional[List[str]]

missing_extract_models: Optional[List[str]]

missing_parse_models: Optional[List[str]]

schema_generation: SchemaGeneration

model: str

status: Literal["available", "unavailable"]

One of the following:

"available"

"unavailable"

class AdminGetOcrStatusResponse: …

Response model for OCR service health/GPU status.

status: Literal["degraded", "ok", "unavailable"]

One of the following:

"degraded"

"ok"

"unavailable"

device: Optional[str]

error_message: Optional[str]

gpu_available: Optional[bool]

gpu_device_count: Optional[int]

gpu_device_name: Optional[str]

AdminUsers

Get User Claims

admin.users.get_claims() -> UserClaims

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

Update User Claims

admin.users.update_claims(, ) -> UserClaims

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

ModelsExpand Collapse

class CustomClaims: …

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[bool]

Whether the user is allowed to delete organizations.

allowed_org_creation: Optional[bool]

Whether the user is allowed to create organizations.

api_datasource_access: Optional[bool]

Whether the user is allowed to access API data sources.

maximum_org_creation: Optional[int]

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

class UserClaims: …

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

claims: CustomClaims

The user’s resolved custom claims.

allow_org_deletion: Optional[bool]

Whether the user is allowed to delete organizations.

allowed_org_creation: Optional[bool]

Whether the user is allowed to create organizations.

api_datasource_access: Optional[bool]

Whether the user is allowed to access API data sources.

maximum_org_creation: Optional[int]

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

user_id: str

The user ID the claims belong to.

AdminUsage Metrics

Aggregate Usage Metrics

admin.usage_metrics.aggregate() -> UsageMetricAggregateResponse

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

ModelsExpand Collapse

class UsageMetricAggregateResponse: …

Response containing usage metrics aggregated by one or more dimensions.

buckets: List[Bucket]

The aggregation buckets, ordered by total credits descending

dimensions: Dict[str, str]

The dimension values that define this bucket

metric_count: int

Number of metric rows in this bucket

total_credits: Union[float, str]

Total credits consumed by metrics in this bucket

One of the following:

float

str

total_value: int

Total of the metric value field in this bucket

group_by: List[Literal["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"