Skip to content
Helix
PricingDocsChangelog
Log inStart free
Documentation
Overview
Getting Started with HelixYour First Mission WalkthroughFocus Mode vs Console ModeDesktop & Mobile Companion Apps
5-Minute API QuickstartIntegrations & Autonomous ChannelsProduction Examples & Recipes
Helix Agent Overview & Autonomy TiersHelix AdvisorHelix OperatorHelix PhasesHelix Sandbox
Synthetic AI & Simulation WorkflowsDrop-In White-Label Agent EmbedsDeveloper & Embed Guide
Helix ArchitectureArchitecture & Technical GuideHybrid Compute Bridge & Custom MCPHelix MCP
MCP Providers & Cloud Connectors
REST, Gateway & MCP API ReferenceAuthentication, Keys & ScopesSDKs & Programmatic ClientsWebhooks, HMAC Verification & ReplayTroubleshooting & Error Playbook
Helix Security ArchitectureEnterprise Security, Secrets & GovernanceBilling, Compute Windows & Quotas
Developer PlatformDeveloper Console
Docs/Quickstarts & Integrations/5-Minute API Quickstart

5-Minute API Quickstart

Deploy an autonomous engineering task inside an isolated Daytona sandbox from any backend, CI runner, or script in five minutes.

Step 1 — Mint a Scoped API Key

Open Developer Console -> API Keys and create a key:

  • hx_live_* — Production runs, file edits, PR creation, and MCP calls.
  • hx_test_* — Dry-run staging checks (does not mutate external services; tags audit receipts isTest: true).

Export it in your shell:

BASH
export HELIX_API_KEY="hx_live_your_generated_key"

Copy the key immediately on creation — Helix stores only its SHA-256 hash and never displays the full secret again.

Step 2 — Choose Your Client SDK

Option A: Official TypeScript SDK (@launchverse/helix-sdk)

BASH
npm install @launchverse/helix-sdk
TS
import { HelixClient } from "@launchverse/helix-sdk";

const helix = new HelixClient({
  baseUrl: "https://launchverse.app",
  apiKey: process.env.HELIX_API_KEY!,
});

// 1. Dispatch an autonomous run (does not block HTTP request timeouts)
const started = await helix.runs.startDetached({
  goal: "Inspect package.json scripts, run vitest, and summarize any failing assertions",
  mode: "supervised",
});

console.log("Started run:", started.runId, "thread:", started.threadId);

Option B: Python (Standard requests / openai Compatible)

PYTHON
import os
import requests

BASE = "https://launchverse.app"
HEADERS = {
    "Authorization": f"Bearer {os.environ['HELIX_API_KEY']}",
    "Content-Type": "application/json",
}

resp = requests.post(
    f"{BASE}/api/v2/runs",
    headers=HEADERS,
    json={
        "goal": "Audit nginx headers in infrastructure/nginx.conf for strict HSTS and CSP.",
        "autonomy": "supervised",
    },
    timeout=30,
)
resp.raise_for_status()
run = resp.json()
print("Run ID:", run["runId"], "Thread ID:", run["threadId"])

Option C: Drop-In cURL

BASH
curl -X POST https://launchverse.app/api/v2/runs \
  -H "Authorization: Bearer $HELIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "goal": "Run static security checks and write a concise remediation summary",
    "autonomy": "supervised"
  }'

Expected JSON response:

JSON
{
  "ok": true,
  "runId": "run_01J...",
  "threadId": "thr_01J...",
  "status": "queued"
}

Step 3 — Stream Telemetry & Handle Approval Gates

Attach to the SSE event stream to observe thoughts, sandbox command outputs, and pause/approval requests in real time:

BASH
curl -N "https://launchverse.app/api/v2/runs/stream?run=${RUN_ID}" \
  -H "Authorization: Bearer $HELIX_API_KEY"

When a run enters awaiting_approval (a T2 gate such as opening a PR or sending an external request), either:

  • Approve from Web Reviews (/helix/reviews) / Desktop / Android, or
  • Decide via API:
TS
await helix.approvals.decide(approvalId, {
  decision: "approved",
  note: "Verified patch diff in CI",
});

Step 4 — Verify Signed Action Receipts

Inspect the cryptographic proof ledger after completion:

TS
const ledger = await helix.approvals.ledger({ limit: 10 });
console.log(ledger);

Next Steps

  • Harden tokens & headers in Authentication & Scopes
  • Configure HTTPS notifications in Webhooks & Replay
  • Explore ready-made CI/CD & Synthetic Data blueprints in Production Examples
PreviousDesktop & Mobile Companion AppsNext Integrations & Autonomous Channels
Edit this page on GitHub↗

Platform

How Helix worksSpecialist crewScreens & architectureSecurity & isolationSystem status

Products

Helix WorkspaceAI Staff & Role PacksEmbedded B2B2C StaffPricing & plans

Developers

Developer PlatformDeveloper ConsoleAPI ReferenceSDKs & CLIWebhooks & events

Resources

DocumentationQuickstart guideChangelogHelp Center

Solutions

Use casesCode migrationCVE remediationMulti-cloud ops

Company

About LaunchVerseCareersContact ussupport@launchverse.app

Legal

Privacy PolicyTerms of ServiceExternal status

Social

Sovereign agentic infrastructure engineered in Africa for global engineering teams.

Helix

AI Specialists & Assistants for Everyday Work.

© 2026 LaunchVerse (Helix). All rights reserved.Privacy·Terms·Security·Status