> ## Documentation Index
> Fetch the complete documentation index at: https://www.agent37.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# REST API reference

> Find endpoints, request examples, response fields, and authentication details.

Use the **Hosting API** to manage sandboxes. Agent templates also provide an **Agent API** for conversations and tools inside an instance.

Start with [Create an instance](/docs/agents-api/instances/create) for a request you can copy, or follow the [Quickstart](/docs/quickstart) to create a sandbox, run a command, and reach a service.

Request examples include required and optional fields in curl, Python, and Node. Replace the example values with yours and omit optional fields you do not need; the field reference describes defaults, accepted values, and alternative forms.

## Hosting API

Manage instances, choose templates, run commands, and route services through HTTPS.

| Resource | Reference |
| - | - |
| Instances | [Create, list, inspect, and delete](/docs/agents-api/instances), [instance object](/docs/agents-api/instances/object) |
| Lifecycle | [Stop](/docs/agents-api/instances/stop), [start](/docs/agents-api/instances/start), [restart](/docs/agents-api/instances/restart), [update](/docs/agents-api/instances/update), [resize](/docs/agents-api/instances/resize), [fork](/docs/agents-api/instances/fork) |
| Backups | [List](/docs/agents-api/instances/list-backups), [create](/docs/agents-api/instances/create-backup), [restore](/docs/agents-api/instances/restore) |
| Templates | [System catalog and your own images](/docs/agents-api/templates) |
| Networking | [Instance and preview URLs](/docs/agents-api/urls), [public ports](/docs/agents-api/public-ports), [custom domains](/docs/agents-api/domains) |
| Execution | [Run commands](/docs/agents-api/exec), [scheduled runs](/docs/agents-api/crons), [SSH](/docs/agents-api/ssh) |
| Operations | [Logs](/docs/agents-api/logs), [metrics](/docs/agents-api/metrics), [budgets](/docs/agents-api/budgets), [integrations](/docs/agents-api/integrations) |

## Agent API

These endpoints are provided by the gateway in agent templates. A custom image or web app does not need to provide a chat API.

| Resource | Reference |
| - | - |
| Conversations | [Send a message](/docs/agents-api/chat), [streaming](/docs/agents-api/streaming), [sessions](/docs/agents-api/sessions) |
| Agent environment | [Models](/docs/agents-api/models), [files](/docs/agents-api/files), [health and version](/docs/agents-api/health) |
| Browser and desktop | [Hermes desktop protocol](/docs/agents-api/hermes-desktop) |

## Authentication and shared reference

See [Core concepts](/docs/agents-api/concepts#two-planes-one-key) for the base URLs and authentication headers for each API. For costs and failures, use [Billing](/docs/agents-api/billing) and [Errors](/docs/agents-api/errors).

Building with a coding agent? [Give it the documentation](/docs/for-agents).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.