OpenAPI Specification
openapi: 3.0.1
info:
title: yatai api server admin api v1 model resource API
description: This is yatai api server.
version: 1.0.0
tags:
- name: model resource
description: model resource
paths:
/api/v1/model_repositories/{modelRepositoryName}/models/{version}:
get:
tags:
- model resource
summary: Get a model
operationId: Get a model
parameters:
- name: modelRepositoryName
in: path
required: true
schema:
type: string
- name: version
in: path
required: true
schema:
type: string
- name: X-Yatai-Organization
in: header
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
bentos:
type: array
items:
type: object
properties:
bento_repository_uid:
type: string
build_at:
type: string
format: date-time
created_at:
type: string
format: date-time
creator:
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
deleted_at:
type: string
format: date-time
nullable: true
description:
type: string
image_build_status:
type: string
labels:
type: array
items:
$ref: '#/components/schemas/ModelschemasLabelItemSchema'
manifest:
$ref: '#/components/schemas/ModelschemasBentoManifestSchema'
name:
type: string
presigned_download_url:
type: string
presigned_upload_url:
type: string
presigned_urls_deprecated:
type: boolean
resource_type:
type: string
enum:
- user
- organization
- cluster
- host_cluster
- bento_repository
- bento
- deployment
- deployment_revision
- model_repository
- model
- api_token
transmission_strategy:
type: string
nullable: true
uid:
type: string
updated_at:
type: string
format: date-time
upload_finished_at:
type: string
format: date-time
nullable: true
upload_finished_reason:
type: string
upload_id:
type: string
upload_started_at:
type: string
format: date-time
nullable: true
upload_status:
type: string
version:
type: string
build_at:
type: string
format: date-time
created_at:
type: string
format: date-time
creator:
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
deleted_at:
type: string
format: date-time
nullable: true
description:
type: string
image_build_status:
type: string
labels:
type: array
items:
$ref: '#/components/schemas/ModelschemasLabelItemSchema'
manifest:
$ref: '#/components/schemas/ModelschemasModelManifestSchema'
model_uid:
type: string
name:
type: string
presigned_download_url:
type: string
presigned_upload_url:
type: string
presigned_urls_deprecated:
type: boolean
repository:
type: object
properties:
created_at:
type: string
format: date-time
creator:
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
deleted_at:
type: string
format: date-time
nullable: true
description:
type: string
labels:
type: array
items:
$ref: '#/components/schemas/ModelschemasLabelItemSchema'
latest_model:
type: object
properties:
build_at:
type: string
format: date-time
created_at:
type: string
format: date-time
creator:
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
deleted_at:
type: string
format: date-time
nullable: true
description:
type: string
image_build_status:
type: string
labels:
type: array
items:
$ref: '#/components/schemas/ModelschemasLabelItemSchema'
manifest:
$ref: '#/components/schemas/ModelschemasModelManifestSchema'
model_uid:
type: string
name:
type: string
presigned_download_url:
type: string
presigned_upload_url:
type: string
presigned_urls_deprecated:
type: boolean
resource_type:
type: string
enum:
- user
- organization
- cluster
- host_cluster
- bento_repository
- bento
- deployment
- deployment_revision
- model_repository
- model
- api_token
transmission_strategy:
type: string
nullable: true
uid:
type: string
updated_at:
type: string
format: date-time
upload_finished_at:
type: string
format: date-time
nullable: true
upload_finished_reason:
type: string
upload_id:
type: string
upload_started_at:
type: string
format: date-time
nullable: true
upload_status:
type: string
version:
type: string
name:
type: string
organization:
type: object
properties:
created_at:
type: string
format: date-time
creator:
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
deleted_at:
type: string
format: date-time
nullable: true
description:
type: string
disable_grafana:
type: boolean
disable_resources_graphs:
type: boolean
enable_endpoints:
type: boolean
enable_mixture_scaling:
type: boolean
enable_monitoring_endpoint:
type: boolean
expired_at:
type: string
format: date-time
nullable: true
labels:
type: array
items:
$ref: '#/components/schemas/ModelschemasLabelItemSchema'
limit_group:
type: string
nullable: true
multi_tenancy:
type: boolean
name:
type: string
public:
type: boolean
resource_type:
type: string
enum:
- user
- organization
- cluster
- host_cluster
- bento_repository
- bento
- deployment
- deployment_revision
- model_repository
- model
- api_token
status:
type: string
uid:
type: string
updated_at:
type: string
format: date-time
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
resource_type:
type: string
enum:
- user
- organization
- cluster
- host_cluster
- bento_repository
- bento
- deployment
- deployment_revision
- model_repository
- model
- api_token
transmission_strategy:
type: string
nullable: true
uid:
type: string
updated_at:
type: string
format: date-time
upload_finished_at:
type: string
format: date-time
nullable: true
upload_finished_reason:
type: string
upload_id:
type: string
upload_started_at:
type: string
format: date-time
nullable: true
upload_status:
type: string
version:
type: string
delete:
tags:
- model resource
summary: Delete a model
operationId: Delete a model
parameters:
- name: modelRepositoryName
in: path
required: true
schema:
type: string
- name: version
in: path
required: true
schema:
type: string
- name: X-Yatai-Organization
in: header
schema:
type: string
responses:
'200':
description: OK
patch:
tags:
- model resource
summary: Update a model
operationId: Update a model
parameters:
- name: modelRepositoryName
in: path
required: true
schema:
type: string
- name: version
in: path
required: true
schema:
type: string
- name: X-Yatai-Organization
in: header
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Update A ModelInput'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
build_at:
type: string
format: date-time
created_at:
type: string
format: date-time
creator:
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
deleted_at:
type: string
format: date-time
nullable: true
description:
type: string
image_build_status:
type: string
labels:
type: array
items:
$ref: '#/components/schemas/ModelschemasLabelItemSchema'
manifest:
$ref: '#/components/schemas/ModelschemasModelManifestSchema'
model_uid:
type: string
name:
type: string
presigned_download_url:
type: string
presigned_upload_url:
type: string
presigned_urls_deprecated:
type: boolean
resource_type:
type: string
enum:
- user
- organization
- cluster
- host_cluster
- bento_repository
- bento
- deployment
- deployment_revision
- model_repository
- model
- api_token
transmission_strategy:
type: string
nullable: true
uid:
type: string
updated_at:
type: string
format: date-time
upload_finished_at:
type: string
format: date-time
nullable: true
upload_finished_reason:
type: string
upload_id:
type: string
upload_started_at:
type: string
format: date-time
nullable: true
upload_status:
type: string
version:
type: string
/api/v1/model_repositories/{modelRepositoryName}/models/{version}/bentos:
get:
tags:
- model resource
summary: List model bentos
operationId: List model bentos
parameters:
- name: modelRepositoryName
in: path
required: true
schema:
type: string
- name: version
in: path
required: true
schema:
type: string
- name: count
in: query
schema:
type: integer
format: int32
- name: q
in: query
schema:
type: string
- name: search
in: query
schema:
type: string
nullable: true
- name: start
in: query
schema:
type: integer
format: int32
- name: X-Yatai-Organization
in: header
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Schemasv1BentoWithRepositoryListSchema'
/api/v1/model_repositories/{modelRepositoryName}/models/{version}/complete_multipart_upload:
patch:
tags:
- model resource
summary: Complete a model multipart upload
operationId: Complete a model multipart upload
parameters:
- name: modelRepositoryName
in: path
required: true
schema:
type: string
- name: version
in: path
required: true
schema:
type: string
- name: X-Yatai-Organization
in: header
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Complete A Model Multipart UploadInput'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
build_at:
type: string
format: date-time
created_at:
type: string
format: date-time
creator:
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:
# --- truncated at 32 KB (183 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bentoml/refs/heads/main/openapi/bentoml-model-resource-api-openapi.yml