Skip to main content

Overview

Build custom agent environments from any Docker image.
Container templates = Custom Docker environments Saved templates (instance.snapshot()) = Workspace snapshots

Create a Template

Parameters

ParameterTypeRequiredDescription
namestringYesHuman-readable template name
imagestringYesBase Docker image (e.g., python:3.11-slim)
registryTypestringYesRegistry type: dockerhub, private, or gcr
descriptionstringNoTemplate description
registryAuthobjectNoAuthentication for private registries

Registry Types

  • dockerhub - Public Docker Hub
  • private - Private registries
  • gcr - Google Container Registry

Build Status

  • buildingready or failed

Wait for Build

List & Get Templates

Use Template

Private Registry

Use environment variables for credentials

Quick Examples

Saved Templates (Snapshots)

Saved templates are workspace snapshots created with instance.snapshot(). They are managed via client.savedTemplates:

Template vs Saved Template

FeatureContainer TemplateSaved Template
Methodclient.templates.create()instance.snapshot()
CreatesCustom Docker environmentWorkspace snapshot
Build time2-5 minutesInstant
Use caseBase environmentsReuse workspaces
Clone withcontainerTemplateId in createcreateFromSavedTemplate()

HTTP API Reference

Create Template

List Templates

Get Template Status

Delete Template

List Saved Templates