Platform
ScaiWave ScaiGrid ScaiCore ScaiBot ScaiDrive ScaiKey Models Tools & Services
Solutions
Organisations Developers Internet Service Providers Managed Service Providers AI-in-a-Box
Resources
Support Documentation Blog Downloads
Company
About Research Careers Investment Opportunities Contact
Log in

Formats, types & enums

The controlled vocabularies used across the API and SDK. The live list of supported formats and quantizations for a deployment comes from GET /api/v1/options/formats and GET /api/v1/options/quantizations.

Model types {#model-types}#

The type on a model (required at creation):

Value Meaning
llm Text-in / text-out language model.
embedding Produces vector embeddings.
image_generation Text/image → image generation.
stt Speech-to-text.
tts Text-to-speech.
multimodal Multiple input/output modalities.
vision_language Image + text understanding.
audio_language Audio + text understanding.
video_language Video + text understanding.
image_to_image Image → image.
audio_to_audio Audio → audio.
vm_image A bootable VM disk image. Not a model; the registry stores it with the same versioning, checksums and access control.

Use modalities ({input: [...], output: [...]}) to describe specifics.

File formats {#formats}#

The format of a version or variant. The catalog is deployment-configurable; the built-in variant formats are:

Value Typical use
safetensors Hugging Face safetensors (common original format).
pytorch PyTorch checkpoints (.pt, .bin).
gguf llama.cpp GGUF (quantized inference).
onnx ONNX graphs.
ext4 Raw ext4 root filesystem image for a microVM, optionally zstd-compressed (.ext4, .ext4.zst).
oci_archive Container image archive as produced by docker save / podman save (.tar).
other Anything else.

Format names match ^[a-z0-9_]+$ — underscores, never hyphens. oci_archive is valid; oci-archive is rejected.

A version's format is a free string validated against the deployment's active formats (1–32 chars, lowercased). Query GET /api/v1/options/formats for the live set and their file_extensions.

Version strings {#version-strings}#

Semver, validated as ^\d+\.\d+\.\d+(-[a-zA-Z0-9.]+)?$.

Example Valid Why
1.0.0 yes
1.20261016.0 yes A date as the minor part is fine.
2.1.0-beta.1 yes Dots are allowed in the prerelease.
1.0.0-sha.1a2b3c4d5e6f yes The usual way to pin a build.
1.0.0-sha-1a2b3c4d5e6f no Hyphens inside the prerelease are rejected.
1.0.0+sha.1a2b3c4d5e6f no Build metadata is not accepted.

The prerelease part is stored in 32 characters.

Quantizations {#quantizations}#

Quantization is a free-text label (≤32 chars) attached to a version or variant, e.g. Q4_K_M, Q8_0, int4, awq-int4. The deployment's catalog (GET /api/v1/options/quantizations, optionally filtered by format_name) records recognized labels along with a bits value.

Version status {#version-status}#

The lifecycle status on a version:

Value Meaning
uploading Created; files being pushed, or pushed but not yet published.
ready Published and downloadable. What you always read.
available The stored spelling of ready. Accepted on write; never returned.
deprecated Downloadable but discouraged.
deleted Soft-deleted.
processing Reserved. Nothing sets it today.
failed Returned by nothing, and cannot be set — writing it returns 422.

A version is only promoted out of uploading when a client marks it; see Version lifecycle.

Variant status {#variant-status}#

Value Meaning
pending Conversion requested, not started.
converting Conversion in progress.
available Ready for download.
failed Conversion failed.

Namespace visibility {#visibility}#

Value Read access
public Anyone.
tenant Users in the same ScaiKey tenant.
private Explicit members only.

Namespace roles {#roles}#

owner › admin › member › viewer. See Authentication for the permissions each grants.

Updated 2026-10-17 01:53:58 View source (.md) rev 2