API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Admin

Get Llm Info

AdminGetLlmsInfoResponse admin().getLlmsInfo(AdminGetLlmsInfoParamsparams = AdminGetLlmsInfoParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/admin/llms/info

Get License Info

AdminGetLicenseInfoResponse admin().getLicenseInfo(AdminGetLicenseInfoParamsparams = AdminGetLicenseInfoParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/admin/license/info

Get File Store Info

AdminGetFilestoresInfoResponse admin().getFilestoresInfo(AdminGetFilestoresInfoParamsparams = AdminGetFilestoresInfoParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/admin/filestores/info

Get Llamaextract Features

AdminGetLlamaextractFeaturesResponse admin().getLlamaextractFeatures(AdminGetLlamaextractFeaturesParamsparams = AdminGetLlamaextractFeaturesParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/admin/llamaextract/features

Get Ocr Health

AdminGetOcrStatusResponse admin().getOcrStatus(AdminGetOcrStatusParamsparams = AdminGetOcrStatusParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/admin/ocr/statusz

AdminUsers

Get User Claims

UserClaims admin().users().getClaims(UserGetClaimsParamsparams = UserGetClaimsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

Update User Claims

UserClaims admin().users().updateClaims(UserUpdateClaimsParamsparams = UserUpdateClaimsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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.

Optional<Boolean> allowOrgDeletion

Whether the user is allowed to delete organizations.

Optional<Boolean> allowedOrgCreation

Whether the user is allowed to create organizations.

Optional<Boolean> apiDatasourceAccess

Whether the user is allowed to access API data sources.

Optional<Long> maximumOrgCreation

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.

CustomClaims claims

The user’s resolved custom claims.

Optional<Boolean> allowOrgDeletion

Whether the user is allowed to delete organizations.

Optional<Boolean> allowedOrgCreation

Whether the user is allowed to create organizations.

Optional<Boolean> apiDatasourceAccess

Whether the user is allowed to access API data sources.

Optional<Long> maximumOrgCreation

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

String userId

The user ID the claims belong to.

AdminUsage Metrics

Aggregate Usage Metrics

UsageMetricAggregateResponse admin().usageMetrics().aggregate(UsageMetricAggregateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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