REST API (V1)

The Faheem Code Sandbox Server is the standalone API and sandbox control plane extracted from the former Faheem Code monorepo. It exposes conversation and sandbox resources without bundling a frontend.

Note

The legacy (V0) API belongs to the archived Local GUI architecture. See the V0 REST API section in the Home tab when maintaining an existing V0 integration.

Overview

Sandbox Server V1 REST endpoints are mounted under:

• /api/v1

Use these endpoints to integrate with the Sandbox Server control plane. Sandbox Server itself does not include a frontend.

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/{id}/pause
  • POST /api/v1/sandboxes/{id}/resume

• Sandbox specs: list the available sandbox “templates” (e.g., Docker image presets).

  • GET /api/v1/sandbox-specs/search