BentoML · Schema
BentoML / BentoCloud API Schemas
JSON Schema definitions extracted from the BentoCloud OpenAPI specification
machine learningmodel servinginferenceAIREST APIMLOpsdeploymentGPULLMBentoCloud
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "BentoML / BentoCloud API Schemas",
"description": "JSON Schema definitions extracted from the BentoCloud OpenAPI specification",
"definitions": {
"Admincontrollersv1SyncOrgCluster": {
"type": "object",
"properties": {
"cluster": {
"type": "string"
},
"message": {
"type": "string"
},
"org": {
"type": "string"
}
}
},
"Admincontrollersv1SyncResultSchema": {
"type": "object",
"properties": {
"failedCount": {
"type": "integer",
"format": "int32"
},
"succeedCount": {
"type": "integer",
"format": "int32"
},
"synced": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Admincontrollersv1SyncOrgCluster"
}
},
"unsynced": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Admincontrollersv1SyncOrgCluster"
}
}
}
},
"Airtable Event CallbackInput": {
"type": "object",
"properties": {
"base": {
"$ref": "#/components/schemas/ServicesAirtableItemSchema"
},
"timestamp": {
"type": "string"
},
"webhook": {
"$ref": "#/components/schemas/ServicesAirtableItemSchema"
}
}
},
"Collect UsageInput": {
"type": "object",
"properties": {
"billable_metric_code": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"record_value": {
"type": "string"
}
}
},
"Complete A Bento Multipart UploadInput": {
"type": "object",
"properties": {
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Schemasv1CompletePartSchema"
}
},
"upload_id": {
"type": "string"
}
}
},
"Complete A Model Multipart UploadInput": {
"type": "object",
"properties": {
"parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Schemasv1CompletePartSchema"
}
},
"upload_id": {
"type": "string"
}
}
},
"Controllersv1CustomerCurrentUsage": {
"type": "object",
"properties": {
"resourceInstanceName": {
"type": "string"
},
"sumCost": {
"type": "number",
"format": "double"
},
"unitCost": {
"type": "number",
"format": "double"
},
"usage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Controllersv1Usage"
}
}
}
},
"Controllersv1CustomerCurrentUsageSchema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Controllersv1CustomerCurrentUsage"
}
}
}
},
"Controllersv1FirebaseInfoSchema": {
"type": "object",
"properties": {
"api_key": {
"type": "string"
},
"auth_domain": {
"type": "string"
}
}
},
"Controllersv1GroupMappingDebug": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"group": {
"type": "string"
},
"role": {
"type": "string"
},
"success": {
"type": "boolean"
},
"target_org_name": {
"type": "string"
}
}
},
"Controllersv1InfoSchema": {
"type": "object",
"properties": {
"disable_login": {
"type": "boolean"
},
"enable_code_space": {
"type": "boolean"
},
"on_prem": {
"type": "boolean"
},
"saas_domain_suffix": {
"type": "string"
}
}
},
"Controllersv1MetricUsageSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"debug": {
"type": "boolean"
},
"debugInfo": {
"description": "Value of any type, including null",
"nullable": true
},
"endTime": {
"type": "string"
},
"granularity": {
"type": "string"
},
"rawLagoResponse": {
"description": "Value of any type, including null",
"nullable": true
},
"startTime": {
"type": "string"
}
}
},
"Controllersv1ModelCategorySchema": {
"type": "object",
"properties": {
"desc": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"Controllersv1ModelEndpointListSchema": {
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Controllersv1ModelCategorySchema"
}
},
"gateways": {
"type": "array",
"items": {
"type": "string"
}
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Controllersv1ModelEndpointSchema"
}
}
}
},
"Controllersv1ModelEndpointSchema": {
"type": "object",
"properties": {
"category": {
"type": "string"
},
"desc": {
"type": "string"
},
"display_name": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
},
"logo": {
"type": "string"
},
"pricing": {
"$ref": "#/components/schemas/ModelstaticModelEndpointPricing"
},
"unique_name": {
"type": "string"
}
}
},
"Controllersv1NewsContent": {
"type": "object",
"properties": {
"blog_posts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Controllersv1NewsItem"
}
},
"documentations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Controllersv1NewsItem"
}
},
"notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Controllersv1NewsItem"
}
},
"release_notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Controllersv1NewsItem"
}
}
}
},
"Controllersv1NewsItem": {
"type": "object",
"properties": {
"cover": {
"type": "string"
},
"ended_at": {
"type": "string"
},
"level": {
"type": "string"
},
"link": {
"type": "string"
},
"started_at": {
"type": "string"
},
"title": {
"type": "string"
},
"version_constraint": {
"type": "string"
}
}
},
"Controllersv1OIDCCallbackResponseSchema": {
"type": "object",
"properties": {
"debug_info": {
"$ref": "#/components/schemas/Controllersv1OIDCDebugInfo"
},
"user": {
"type": "object",
"properties": {
"application_status": {
"type": "string"
},
"avatar_url": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"email": {
"type": "string"
},
"first_name": {
"type": "string"
},
"from_sso": {
"type": "boolean"
},
"is_super_admin": {
"type": "boolean"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelschemasLabelItemSchema"
}
},
"last_name": {
"type": "string"
},
"name": {
"type": "string"
},
"perm": {
"type": "string"
},
"register_stage": {
"type": "string"
},
"resource_type": {
"type": "string",
"enum": [
"user",
"organization",
"cluster",
"host_cluster",
"bento_repository",
"bento",
"deployment",
"deployment_revision",
"model_repository",
"model",
"api_token"
]
},
"uid": {
"type": "string"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
}
},
"Controllersv1OIDCDebugInfo": {
"type": "object",
"properties": {
"current_org_id": {
"type": "integer",
"format": "int32"
},
"current_org_name": {
"type": "string"
},
"processed_mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Controllersv1GroupMappingDebug"
}
},
"user_groups": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Controllersv1OIDCInfoSchema": {
"type": "object",
"properties": {
"client_id": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"provider_url": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Controllersv1SecretTemplate": {
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ModelschemasSecretNoValueContent"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"Controllersv1Usage": {
"type": "object",
"properties": {
"endTime": {
"type": "string"
},
"startTime": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"Controllersv2CreateRequestQuotaSchema": {
"type": "object",
"properties": {
"current_quota": {
"type": "string"
},
"gpu_type": {
"type": "string"
},
"reason": {
"type": "string"
},
"requested_quota": {
"type": "string"
},
"resource_type": {
"type": "string"
}
},
"required": [
"resource_type"
]
},
"Create A BentoInput": {
"type": "object",
"properties": {
"build_at": {
"type": "string"
},
"description": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelschemasLabelItemSchema"
}
},
"manifest": {
"$ref": "#/components/schemas/ModelschemasBentoManifestSchema"
},
"version": {
"type": "string"
}
}
},
"Create A Cluster Member In Admin PanelInput": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"guest",
"developer",
"admin",
"api_user"
]
},
"usernames": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Create A Cluster MemberInput": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"guest",
"developer",
"admin",
"api_user"
]
},
"usernames": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Create A Gpu ConfigInput": {
"type": "object",
"properties": {
"memory": {
"type": "string"
},
"name": {
"type": "string"
},
"vendor": {
"type": "string"
}
}
},
"Create A Limit GroupInput": {
"type": "object",
"properties": {
"config": {
"$ref": "#/components/schemas/ModelschemasLimitGroupConfigSchema"
},
"description": {
"type": "string"
},
"display_name": {
"type": "string"
},
"name": {
"type": "string"
},
"plan_code": {
"type": "string"
},
"visible": {
"type": "boolean",
"nullable": true
}
}
},
"Create A Model RepositoryInput": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelschemasLabelItemSchema"
}
},
"name": {
"type": "string"
}
}
},
"Create A ModelInput": {
"type": "object",
"properties": {
"build_at": {
"type": "string"
},
"description": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelschemasLabelItemSchema"
}
},
"manifest": {
"$ref": "#/components/schemas/ModelschemasModelManifestSchema"
},
"version": {
"type": "string"
}
}
},
"Create A Request QuotaInput": {
"type": "object",
"properties": {
"current_quota": {
"type": "string"
},
"gpu_type": {
"type": "string"
},
"reason": {
"type": "string"
},
"requested_quota": {
"type": "string"
},
"resource_type": {
"type": "string"
}
},
"required": [
"resource_type"
]
},
"Create A Resource InstanceInput": {
"type": "object",
"properties": {
"config": {
"$ref": "#/components/schemas/ModelschemasResourceInstanceConfigSchema"
},
"description": {
"type": "string"
},
"display_name": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"Create A SecretInput": {
"type": "object",
"properties": {
"content": {
"$ref": "#/components/schemas/ModelschemasSecretContent"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"Create An EndpointInput": {
"type": "object",
"properties": {
"deployment_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"deployment_weights": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
}
},
"domain": {
"type": "string"
},
"load_balance": {
"type": "string"
},
"name": {
"type": "string"
},
"overflow_scale_out_delay": {
"type": "integer",
"format": "int32",
"nullable": true
},
"protocol": {
"type": "string"
},
"strategy": {
"type": "string"
},
"upstreams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelschemasEndpointUpstream"
}
}
}
},
"Create An Organization MemberInput": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"guest",
"developer",
"admin",
"api_user"
]
},
"usernames": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Create An UserInput": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"guest",
"developer",
"admin",
"api_user"
]
}
},
"required": [
"email",
"name",
"password"
]
},
"Create Api TokenInput": {
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"deployment_uids": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"expired_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"is_global_access": {
"type": "boolean"
},
"is_global_router_access": {
"type": "boolean"
},
"is_monitoring_token": {
"type": "boolean"
},
"is_organization_token": {
"type": "boolean"
},
"name": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Create Bento RepositoryInput": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelschemasLabelItemSchema"
}
},
"name": {
"type": "string"
}
}
},
"Create Cluster In Admin PanelInput": {
"type": "object",
"properties": {
"config": {
"$ref": "#/components/schemas/ModelschemasClusterConfigSchema"
},
"description": {
"type": "string"
},
"host_cluster_name": {
"type": "string"
},
"image_resgitry_config": {
"$ref": "#/components/schemas/ModelschemasImageResgitryConfig"
},
"multi_tenancy": {
"type": "boolean"
},
"name": {
"type": "string"
}
}
},
"Create ClusterInput": {
"type": "object",
"properties": {
"config": {
"$ref": "#/components/schemas/ModelschemasClusterConfigSchema"
},
"description": {
"type": "string"
},
"host_cluster_name": {
"type": "string"
},
"image_resgitry_config": {
"$ref": "#/components/schemas/ModelschemasImageResgitryConfig"
},
"multi_tenancy": {
"type": "boolean"
},
"name": {
"type": "string"
}
}
},
"Create Deployment V2Input": {
"type": "object",
"properties": {
"access_authorization": {
"type": "boolean",
"nullable": true
},
"bento": {
"type": "string"
},
"canary": {
"$ref": "#/components/schemas/Schemasv2DeploymentCanarySchema"
},
"description": {
"type": "string",
"nullable": true
},
"dev": {
"type": "boolean"
},
"distributed": {
"type": "boolean",
"nullable": true
},
"envs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelschemasEnvItemSchema"
}
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelschemasLabelItemSchema"
}
},
"name": {
"type": "string"
},
"secrets": {
"type": "array",
"items": {
"type": "string"
}
},
"services": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ModelschemasDeploymentServiceConfig"
}
},
"weight": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
},
"Create DeploymentInput": {
"type": "object",
"properties": {
"cluster": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"dev": {
"type": "boolean"
},
"distributed": {
"type": "boolean",
"nullable": true
},
"kube_namespace": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelschemasLabelItemSchema"
}
},
"mode": {
"type": "string",
"nullable": true
},
"name": {
"type": "string"
},
"routing": {
"$ref": "#/components/schemas/ModelschemasDeploymentRoutingSchema"
},
"super_admin": {
"type": "boolean"
},
"targets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Schemasv1CreateDeploymentTargetSchema"
}
}
}
},
"Create Host ClusterInput": {
"type": "object",
"properties": {
"config": {
"$ref": "#/components/schemas/ModelschemasHostClusterConfigSchema"
},
"default": {
"type": "boolean"
},
"description": {
"type": "string"
},
"display_name": {
"type": "string"
},
"kube_config": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"Create Lago Billable MetricInput": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"display_name": {
"type": "string"
}
}
},
"Create Lago CustomerInput": {
"type": "object",
"properties": {
"Uid": {
"type": "string"
},
"auto_create_stripe": {
"type": "boolean"
},
"credit_amount": {
"type": "string",
"nullable": true
},
"email": {
"type": "string"
},
"limit_group_plan": {
"type": "string"
},
"name": {
"type": "string"
},
"plan_type": {
"type": "string"
}
}
},
"Create Lago PlanInput": {
"type": "object",
"properties": {
"charges": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Schemasv1Charge"
}
},
"description": {
"type": "string"
},
"display_name": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"Create OrganizationInput": {
"type": "object",
"properties": {
"config": {
"$ref": "#/components/schemas/ModelschemasOrganizationConfigSchema"
},
"description": {
"type": "string"
},
"limit_group_name": {
"type": "string",
"nullable": true
},
"multi_tenancy": {
"type": "boolean"
},
"name": {
"type": "string"
},
"public": {
"type": "boolean"
}
}
},
"Finish Upload A BentoInput": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
}
}
},
"Finish Upload A ModelInput": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
}
}
},
"IntstrIntOrString": {
"type": "object",
"properties": {
"IntVal": {
"type": "integer",
"format": "int32"
},
"StrVal": {
"type": "string"
},
"Type": {
"type": "integer",
"format": "int64"
}
}
},
"Invite An UserInput": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"guest",
"developer",
"admin",
"api_user"
]
}
},
"required": [
"email",
"first_name",
"last_name"
]
},
"List Secrets With Check MessageInput": {
"type": "object",
"properties": {
"names": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Login An UserInput": {
"type": "object",
"properties": {
"name_or_email": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": [
"name_or_email",
"password"
]
},
"Migrate Deployments On Cluster In Admin PanelInput": {
"type": "object",
"properties": {
"targetClusterName": {
"type": "string"
}
}
},
"ModelschemasAWSECRSchema": {
"type": "object",
"properties": {
"account_id": {
"type": "string"
},
"bentos_repository_name": {
"type": "string"
},
"models_repository_name": {
"type": "string"
},
"password": {
"type": "string"
},
"region": {
"type": "string"
}
}
},
"ModelschemasAWSS3Schema": {
"type": "object",
"properties": {
"bentos_bucket_name": {
"type": "string"
},
"models_bucket_name": {
"type": "string"
},
"region": {
"type": "string"
}
}
},
"ModelschemasApiServerBentoFunctionOverrides": {
"type": "object",
"properties": {
"annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"extraPodMetadata": {
"$ref": "#/components/schemas/V1alpha1ExtraPodMetadata"
},
"extraPodSpec": {
"$ref": "#/components/schemas/V1alpha1ExtraPodSpec"
},
"monitorExporter": {
"$ref": "#/components/schemas/V1alpha1MonitorExporterSpec"
}
}
},
"ModelschemasBentoApiSchema": {
"type": "object",
"properties": {
"doc": {
"type": "string"
},
"input": {
"type": "string"
},
"output": {
"type": "string"
},
"route": {
"type": "string"
}
}
},
"ModelschemasBentoImageInfoSchema": {
"type": "object",
"properties": {
"base_image": {
"type": "string"
},
"commands": {
"type": "array",
"items": {
"type": "string"
}
},
"python_requirements": {
"type": "string"
},
"python_version": {
"type": "string"
}
}
},
"ModelschemasBentoManifestModelSchema": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"creation_time": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"module": {
"type": "string"
},
"registry": {
"type": "string"
},
"tag": {
"type": "string"
}
}
},
"ModelschemasBentoManifestSchema": {
"type": "object",
"properties": {
"apis": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ModelschemasBentoApiSchema"
}
},
"bentoml_version": {
"type": "string"
},
"dev": {
"type": "boolean"
},
"entry_service": {
"type": "string"
},
"envs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelschemasEnvItemSchema"
}
},
"image": {
"$ref": "#/components/schemas/ModelschemasBentoImageInfoSchema"
},
"models": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"runners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelschemasBentoRunnerSchema"
}
},
"schema": {
"type": "object",
"additionalProperties": {}
},
"service": {
"type": "string"
},
"services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelschemasBentoManifestServiceSchema"
}
},
"size_bytes": {
"type": "integer",
"format": "int32"
},
"spec": {
"type": "integer",
"format": "int32"
}
}
},
"ModelschemasBentoManifestServiceSchema": {
"type": "object",
"properties": {
"config": {
"type": "object",
"additionalProperties": {}
},
"models": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelschemasBentoManifestModelSchema"
}
},
"name": {
"type": "string"
},
"service": {
"type": "string"
}
}
},
"ModelschemasBentoRequestOverrides": {
"type": "object",
"properties": {
"dockerConfigJsonSecretName": {
"type": "string"
},
"downloaderContainerEnvFrom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/V1EnvFromSource"
}
},
"imageBuildTimeout": {
"type": "integer",
"format": "int64",
"nullable": true
},
"imageBuilderContainerResources": {
"$ref": "#/components/schemas/V1ResourceRequirements"
},
"imageBuilderExtraContainerEnv": {
"type": "array",
"items": {
# --- truncated at 32 KB (1246 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bentoml/refs/heads/main/json-schema/bentoml-schemas.json