Skip to main content
Base URL https://api.voyager.so/v1/machines. Authenticate with Authorization: Bearer $VOYAGER_API_KEY, or as voyager-cloud does after voyager-cloud login. Every endpoint, with full request and response schemas, is also in the generated API reference group in the sidebar and in the OpenAPI document at api.voyager.so/v1/openapi.json. Every route that takes a machine id (mch_…) also takes its name. root defaults to /project, which is also the default cwd for commands. Run and file calls on a paused machine resume it first and say resumed: true. Pause, resume, release, run and snapshot accept an Idempotency-Key.

Values

Errors

Errors use the API’s error envelope ({"error": {"code", "message", "retryable", "details", …}}). Machine error codes are UPPER_SNAKE. 429 and 503 responses send Retry-After. Retry only when retryable is true, with the same Idempotency-Key. A machine that fails while starting has status: failed and an error with a code and message. A failed machine doesn’t bill.