tenant-admin
Scout API 1.0.0 — see schemas for shared types.
GET /api/tenant-admin/default-embedding-model
get_default_embedding_model
Responses
- 200 — OK
application/json→ DefaultEmbeddingModelResponse- 422 — Unprocessable Content
application/json→ ValidationError
PUT /api/tenant-admin/default-embedding-model
update_default_embedding_model
Request body
Content-Type: application/json
Schema: UpdateDefaultEmbeddingModelRequest
Responses
- 200 — OK
application/json→ DefaultEmbeddingModelResponse- 422 — Unprocessable Content
application/json→ ValidationError
PUT /api/tenant-admin/default-model
update_default_model
Request body
Content-Type: application/json
Schema: UpdateDefaultModelRequest
Responses
- 200 — OK
application/json→ DefaultModelResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/tenant-admin/features
list_manageable_features
Responses
- 200 — OK
application/json→ ManageableFeatureResponseList- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/tenant-admin/features/{feature_key}/visibility
get_feature_visibility
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
feature_key |
path | string | yes |
Responses
- 200 — OK
application/json→ TenantFeatureVisibilityResponse- 422 — Unprocessable Content
application/json→ ValidationError
PUT /api/tenant-admin/features/{feature_key}/visibility
update_feature_visibility
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
feature_key |
path | string | yes |
Request body
Content-Type: application/json
Schema: FeatureVisibilityRequest
Responses
- 200 — OK
application/json→ TenantFeatureVisibilityResponse- 422 — Unprocessable Content
application/json→ ValidationError
POST /api/tenant-admin/invitations
create_invitations
Request body
Content-Type: application/json
Schema: CreateInvitationsRequest
Responses
- 201 — Created
application/json→ CreateInvitationsResponse- 422 — Unprocessable Content
application/json→ ValidationError
POST /api/tenant-admin/logo/upload
upload_tenant_logo
Request body
Content-Type: multipart/form-data
Schema: UploadTenantLogoForm
Responses
- 200 — OK
application/json→ AssistantUploadImageResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/tenant-admin/models/{model_id}/visibility
get_model_visibility
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
model_id |
path | string | yes |
Responses
- 200 — OK
application/json→ TenantModelVisibilityResponse- 422 — Unprocessable Content
application/json→ ValidationError
PUT /api/tenant-admin/models/{model_id}/visibility
update_model_visibility
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
model_id |
path | string | yes |
Request body
Content-Type: application/json
Schema: ModelVisibilityRequest
Responses
- 200 — OK
application/json→ TenantModelVisibilityResponse- 422 — Unprocessable Content
application/json→ ValidationError
PUT /api/tenant-admin/provider-api-keys
update_provider_api_keys
Request body
Content-Type: application/json
Schema: UpdateProviderApiKeysRequest
Responses
- 200 — OK
application/json→ ProviderApiKeysResponse- 422 — Unprocessable Content
application/json→ ValidationError
PUT /api/tenant-admin/provisioning-mode
update_provisioning_mode
Request body
Content-Type: application/json
Schema: UpdateProvisioningModeRequest
Responses
- 200 — OK
application/json→ ProvisioningModeResponse- 422 — Unprocessable Content
application/json→ ValidationError
POST /api/tenant-admin/service-accounts
create_service_account
Request body
Content-Type: application/json
Schema: CreateServiceAccountRequest
Responses
- 200 — OK
application/json→ TenantMemberResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/tenant-admin/service-accounts/{user_id}/api-tokens
list_service_account_api_tokens
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
user_id |
path | string (uuid) | yes |
Responses
- 200 — OK
application/json→ ApiTokensResponse- 422 — Unprocessable Content
application/json→ ValidationError
POST /api/tenant-admin/service-accounts/{user_id}/api-tokens
create_service_account_api_token
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
user_id |
path | string (uuid) | yes |
Request body
Content-Type: application/json
Schema: CreateServiceAccountApiTokenRequest
Responses
- 201 — Created
application/json→ ApiTokensTokenResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/tenant-admin/service-accounts/{user_id}/api-tokens/{token_id}
get_service_account_api_token
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
user_id |
path | string (uuid) | yes | |
token_id |
path | string (uuid) | yes |
Responses
- 200 — OK
application/json→ ApiTokensTokenResponse- 422 — Unprocessable Content
application/json→ ValidationError
PUT /api/tenant-admin/service-accounts/{user_id}/api-tokens/{token_id}
update_service_account_api_token
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
user_id |
path | string (uuid) | yes | |
token_id |
path | string (uuid) | yes |
Request body
Content-Type: application/json
Schema: UpdateApiTokenBody
Responses
- 200 — OK
application/json→ ApiTokensTokenResponse- 422 — Unprocessable Content
application/json→ ValidationError
PATCH /api/tenant-admin/service-accounts/{user_id}/display-name
update_service_account_display_name
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
user_id |
path | string (uuid) | yes |
Request body
Content-Type: application/json
Schema: UpdateUserDisplayNameRequest
Responses
- 200 — OK
application/json→ TenantMemberResponse- 422 — Unprocessable Content
application/json→ ValidationError
POST /api/tenant-admin/service-accounts/{user_id}/login-as
login_as_service_account
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
user_id |
path | string (uuid) | yes |
Responses
- 200 — OK
application/json→ LoginResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/tenant-admin/usage-report/daily/export
export_daily_user_costs
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
from_date |
query | string | null | no | |
to_date |
query | string | null | no |
Responses
GET /api/tenant-admin/users/{user_id}/resolved-features
get_user_resolved_features
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
user_id |
path | string (uuid) | yes |
Responses
- 200 — OK
application/json→ UserResolvedFeatureResponseList- 422 — Unprocessable Content
application/json→ ValidationError
PUT /api/tenant-admin/users/{user_id}/role
update_user_role
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
user_id |
path | string (uuid) | yes |
Request body
Content-Type: application/json
Schema: UpdateUserRoleRequest
Responses
- 200 — OK
application/json→ TenantMemberResponse- 422 — Unprocessable Content
application/json→ ValidationError