# Wheelmachine

> Machines for agents and people, by the second: make one in well under a second, run commands in it, copy files in and out, pause it with its memory kept, copy it while it runs, and delete it. One HTTPS API at https://api.wheelmachine.ai with keys `ak_live_...`, a command line (`wm`), Python and TypeScript libraries, and an MCP server (`wm-mcp`) for agents.

Every page below is also there as Markdown (the same address, ending .md). Errors are application/problem+json with a stable `code`; each code has its own page under /errors/.

## Start

- [Wheelmachine docs](https://docs.wheelmachine.ai/index.md): Machines for agents and people, by the second. Make one, run commands in it, copy files in and out, pause it and delete it, from a terminal, from Python or TypeScript, or from an agent.
- [Quickstart](https://docs.wheelmachine.ai/quickstart.md): From a key to a running machine: log in, make a machine, run a command in it, copy a file in and out, pause it and delete it.

## Guides

- [Machines](https://docs.wheelmachine.ai/machines.md): What a machine is: its states, its sizes, how it sleeps when idle, copies, snapshots, names, labels, projects, where it runs and what it costs.
- [Commands and files](https://docs.wheelmachine.ai/commands-and-files.md): Run any command in a machine and get what it wrote, with or without a shell, as its user or as root; copy files in and out of it.
- [Keys and scopes](https://docs.wheelmachine.ai/keys.md): What a key may do: the cloud scopes, keys limited to some projects, end times and rates, revoking, and why a key never makes a stronger one.
- [Errors](https://docs.wheelmachine.ai/errors/index.md): How the API refuses a call: application/problem+json with a stable code, a request id, and when to try again. Every code, and what to do about it.
- [Limits](https://docs.wheelmachine.ai/limits.md): How many calls a key may make, how many machines an account may hold, the largest request, file, command and output, and what happens when the money runs out.

## Tools

- [Command line](https://docs.wheelmachine.ai/cli.md): The wm command: install it, log in, and every command and flag for machines, commands, files, projects, keys and the catalogue.
- [Libraries](https://docs.wheelmachine.ai/libraries.md): The Python and TypeScript libraries: install, the client, every method, errors, retries that never make two, long calls, lists and files.
- [Agents](https://docs.wheelmachine.ai/agents.md): Give an agent machines of its own: the wm-mcp server for MCP clients, a key that holds only what the agent needs, every tool it offers, and how failures come back.

## Reference

- [API reference](https://docs.wheelmachine.ai/reference.md): Every route of the Wheelmachine API, with its scope, fields, answers and an example, made from the API's contract (OpenAPI 3.1).

## Optional

- [Every page at once](https://docs.wheelmachine.ai/llms-full.txt): the whole site as one Markdown file
- [The API's contract](https://docs.wheelmachine.ai/openapi.yaml): OpenAPI 3.1, every route, field and error code (also as [JSON](https://docs.wheelmachine.ai/openapi.json))