Skip to main content
amika-server exposes the Amika service over REST. The server serves OpenAPI metadata at /openapi.json and interactive docs at /docs.

Start the server

amika-server
By default, the server listens on :8080.

Endpoints

MethodPathDescription
GET/v1/healthHealth check
GET/v1/sandboxesList sandboxes
POST/v1/sandboxesCreate sandbox
DELETE/v1/sandboxes/{name}Delete sandbox
GET/v1/volumesList volumes
DELETE/v1/volumes/{name}Delete volume
POST/v1/auth/extractExtract credentials
POST/v1/materializeRun materialization

API-only request field

POST /v1/sandboxes accepts SetupScriptText, which lets you send setup script content inline. This field is mutually exclusive with file-path based SetupScript.