# Homemade docs - [Homemade API](/index.md): Create VMs for your projects, run commands in them, put them to sleep and delete them, from any language that can send an HTTP request. - [Quickstart](/quickstart.md): Create a VM from one of your projects, run a command in it, read the output and delete the VM. - [Projects and VMs](/projects-and-vms.md): What you get when you create a project and a VM, and the sizes a VM can have. - [Configuration](/configuration.md): Describe how a project runs in .homemade/config, or start from a template. - [Previews](/previews.md): Every service that publishes a URL gets a preview link. Choose who can open it and what visitors see while a sleeping VM wakes. - [Sleep and wake](/sleep-and-wake.md): VMs sleep when idle and pick up where you left off when they wake. What you pay while a VM sleeps. - [AI tools](/ai-tools.md): Coding agents installed on every VM, with Claude Code and Codex signed in, and chat in the dashboard. - [Forks and branches](/forks-and-branches.md): Start a VM from any branch, or fork a running VM to try something without touching the original. - [Pricing and plans](/pricing.md): What Hobby and Pro include, and what each VM size costs. - [What we log](/what-we-log.md): Everything homemade records about your VMs and why, and everything it never records. - [Authentication and errors](/authentication.md): Send an API key on every request, and read errors by status and code. - [CLI](/cli.md): Install the homemade CLI, sign in, and work with your VMs from a terminal, a script or a coding agent. - **API reference** - Account - [Get the current user](/api-reference/account/get-me.md): The key's owner and the teams it can reach. A team's `id` is the `orgId` other calls take. - Projects - [Create a project](/api-reference/projects/create-project.md): Creates a project from a GitHub repository your team connected (`githubInstallationId` + `githubRepoId`), from a starter (`template`), or empty. A new project starts its first VM on its own; `welcomeVm` says how that went. - [Delete a project](/api-reference/projects/delete-project.md): Deletes the project and every VM in it. This cannot be undone. - [Get a project](/api-reference/projects/get-project.md) - [List branches](/api-reference/projects/list-project-branches.md): The branches a VM of this project can boot, the default branch first. - [List projects](/api-reference/projects/list-projects.md): Every project in your teams, newest first. Pass `orgId` for one team's projects. - [Update project settings](/api-reference/projects/update-project-settings.md): Changes the project's slug, default branch, default auto-sleep and other settings. Every field is optional. - [Validate a project config](/api-reference/projects/validate-config.md): Checks a `.homemade/config.json` or `.jsonc` file against the config schema. `.ts` and `.js` configs are checked at the first build instead. - VMs - [Create a VM](/api-reference/vms/create-vm.md): Creates a VM from a project's latest build and starts it. The answer comes at once with the VM in `queued` or `booting`; poll `GET /api/vms/{vmId}` until `state` is `running`. - [Delete a VM](/api-reference/vms/delete-vm.md): Deletes the VM and its data. This cannot be undone. - [Dismiss the agent signal](/api-reference/vms/dismiss-vm-signal.md): Clears the attention signal an agent in the VM raised. Does nothing when there is none. - [Extend auto-sleep](/api-reference/vms/extend-vm-sleep.md): Moves a running VM's auto-sleep deadline by `minutes` (negative pulls it in). - [Get VM runtime status](/api-reference/vms/get-vm-runtime.md): What the VM reports right now: its boot steps, service health, CPU, memory and disk. - [Get a VM](/api-reference/vms/get-vm.md): The VM, its project, its services and its newest events. `vm.urls` holds each service's public URL by port. - [List VMs](/api-reference/vms/list-vms.md): Every VM in your teams that is not deleted, newest first. Pass `projectId` to list one project's VMs. - [Sleep a VM](/api-reference/vms/sleep-vm.md): Puts a running VM to sleep. It keeps its memory and disk and wakes where it left off. Sleeping an asleep VM answers 200. - [Update a VM](/api-reference/vms/update-vm.md): Renames the VM, changes its auto-sleep or who can open its services. Every field is optional. - [Wake a VM](/api-reference/vms/wake-vm.md): Wakes an asleep VM. Poll `GET /api/vms/{vmId}` until `state` is `running`. - Exec - [Run a command](/api-reference/exec/exec-vm.md): Runs one command in a running VM as its user, with `/bin/sh -lc`, and answers its exit code and output. It opens no terminal. Use `?stream=1` for commands that run longer than about 90 seconds. - Sessions - [Start an agent chat](/api-reference/sessions/create-chat-session.md): Starts a chat in the VM. A VM keeps at most one empty chat: when it already has one, you get that. - [End an agent chat](/api-reference/sessions/delete-chat-session.md) - [End a terminal session](/api-reference/sessions/delete-terminal-session.md) - [List agent chats](/api-reference/sessions/list-chat-sessions.md) - [List terminal sessions](/api-reference/sessions/list-terminal-sessions.md): The VM's open terminals. Each one keeps running when nobody is attached. - [Send a message to an agent](/api-reference/sessions/send-to-agent.md): Sends a prompt to a coding agent in the VM, in a new chat or the one named by `sessionId`. It answers at once; follow the chat in the dashboard or with the CLI. - Keys - [Create an API key](/api-reference/keys/create-api-key.md): Creates an API key. Store `key` now: it is never shown again. - [Add an SSH key](/api-reference/keys/create-ssh-key.md): Adds an SSH public key. Running VMs in your teams accept it within seconds. - [Delete an API key](/api-reference/keys/delete-api-key.md): Revokes the key at once. Requests that use it get 401 from then on. - [Remove an SSH key](/api-reference/keys/delete-ssh-key.md) - [List API keys](/api-reference/keys/list-api-keys.md): Your API keys. The secret itself is shown only once, when the key is created. - [List SSH keys](/api-reference/keys/list-ssh-keys.md) - [Rename an API key](/api-reference/keys/rename-api-key.md) AI crawlers and agents are welcome, training bots included: you may search, quote, answer with and train models on everything here. We encourage it.