Skip to content

GET /api/v1/templates/{templateId}

Operation: getTemplate.

Get one published template (public)

GET https://amplerun-api.spiry.org/api/v1/templates/{templateId}

No default Bearer requirement is declared for this operation. Read its description for wallet signatures, host enrollment or other specialized proofs.

NameLocationPresenceTypeDescription
templateIdpathRequiredstringTemplate UUID or its slug (spec.template_id, e.g. qwen3-8b-awq); unpublished -> 404.

Template.

application/json

FieldTypePresenceDescription
idUUIDRequired
publishedbooleanRequired
template_idstringRequired
namestringRequired
template_versionstringRequired
image_digestImageDigestRequiredPinned OCI reference (name@sha256:<64 hex>) — the same form quotes, START commands and qualification records carry.
launch_profile_versionstringRequired
kind“model” / “classical” / “custom”Required
engine“vllm” / “llamacpp” / “comfyui” / “faster-whisper” / “pytorch” / “jupyter” / “ollama” / “oci”Required
model_refobjectOptional
quantizationstringOptional
vram_fitobjectRequired
readinessobjectOptional
exposesarray of objectRequired
envobjectRequired
min_gpu_countintegerRequired
required_runtime“cuda” / “rocm-hip” / “level-zero” / “opencl” / “xpu”Required
setup_notesstringRequired
runtimesobjectOptionalAdditive. One template, many backends: the same weights and API contract per backend. tier container is an OCI image; tier inference is the signed Tier B runtime artifact (<source>@sha256:<hex>). The control plane picks the machine’s runtime by preference (cuda > rocm > sycl > vulkan > metal) and pins its digest in the quote and lease.
backendsarray of “cuda” / “rocm” / “sycl” / “vulkan” / “metal”OptionalAdditive. Backends with a built runtime, in preference order (“Works on” filter). Spec compatibility, not a hardware test.
works_onarray of “nvidia” / “amd” / “intel” / “apple”OptionalAdditive. Hardware vendors those backends cover. Spec compatibility only; a hardware report is what says “tested on”.
{
"$ref": "#/components/schemas/Template"
}

Error envelope. 401 unauthenticated, 403/404 forbidden, 409 conflict, 422 invalid input, 429 rate limited (code UNAVAILABLE, retryable:true, no Retry-After header), 503 unavailable money/provider state with retryable:true.

application/json

FieldTypePresenceDescription
errorobjectRequired
{
"$ref": "#/components/schemas/ErrorEnvelope"
}

Replace path/query placeholders and provide the required JSON body, headers and credential from the sections above. This is a request outline, not a command that chooses an amount or starts a rental for you.

Terminal window
curl --request GET 'https://amplerun-api.spiry.org/api/v1/templates/{templateId}'

Schema definitions · Download OpenAPI · Authentication · Errors and recovery

Official AmpleRun documentation · Contract v3 · Generated from the API contract · Revision 52fe29de · Open AmpleRun · View Markdown · For agents