Skip to main content
OpenHands is in a transition period: legacy (V0) endpoints still exist alongside the new /api/v1 endpoints.If you need the legacy OpenAPI reference, see the Web (V0) tab.

​
Overview

OpenHands V1 REST endpoints are mounted under:
  • /api/v1
These endpoints back the current Web UI and are intended for newer integrations.

​
Key resources

The V1 API is organized around a few core concepts:
  • App conversations: create/list conversations and access conversation metadata.
    • POST /api/v1/app-conversations
    • GET /api/v1/app-conversations
  • Sandboxes: list/start/pause/resume the execution environments that power conversations.
    • GET /api/v1/sandboxes/search
    • POST /api/v1/sandboxes
    • POST /api/v1/sandboxes//pause
    • POST /api/v1/sandboxes//resume
  • Sandbox specs: list the available sandbox “templates” (e.g., Docker image presets).
    • GET /api/v1/sandbox-specs/search