Skip to main content
Import OCI container image from registry. Spawns microVM. Check first: Use list_images to see if already imported.

Authentication

Before importing, authenticate with the registry:
  1. Call registry_token_obtain to open browser for PAT creation
  2. User creates read-only PAT in registry web UI
  3. Call registry_auth to validate and store credentials
Anonymous access is possible but discouraged due to registry provider rate limits.

Parameters

ParameterTypeDefaultDescription
registry_urlstringrequiredRegistry URL (e.g., docker://python:3.11)
tagstring-Tag to assign after import
waitbooleantrueWait for completion
i_accept_that_anonymous_access_might_be_rate_limitedbooleanfalseSkip authentication (not recommended)

Examples

Basic (requires prior authentication):
{"registry_url": "docker://python:3.11-slim"}
With tag:
{"registry_url": "docker://alpine:latest", "tag": "alpine:latest"}
Anonymous access (rate limited):
{"registry_url": "docker://alpine:latest", "i_accept_that_anonymous_access_might_be_rate_limited": true}
Async:
{"registry_url": "docker://pytorch/pytorch:2.0-cuda11.7", "wait": false}

Response

{"result_image": "abc123-uuid", "result_tag": "python:3.11", "state": "SUCCESS"}
With wait=false: {"operation_id": "op-xxx"}

Common Base Images

Registry URLUse Case
docker://python:3.11-slimPython
docker://node:20-slimNode.js
docker://alpine:latestMinimal Linux
docker://ubuntu:22.04Full Linux
docker://golang:1.21Go

Parallel Imports

{"registry_url": "docker://python:3.11", "wait": false}
{"registry_url": "docker://node:20", "wait": false}
{"tool": "wait_operations", "args": {"operation_ids": ["op-1", "op-2"]}}