← Home/

HELVA CLOUD API Reference

API-first documentation for HELVA CLOUD. This page defines the request conventions and endpoint documentation structure used by developers and coding assistants.

Docs status: active draft • Last docs sync: 2026-02-24

Page Summary

Quick Answer

Use this page to understand how HELVA CLOUD APIs are documented and called: base URL, auth, request/response format, endpoint status labels, errors, and rate limits.

Who this is for

  • - Developers
  • - Integrators
  • - AI coding assistants
  • - Technical founders evaluating API fit

What you can do here

  • - Find the API base URL and versioning model
  • - Learn authentication and headers
  • - Understand JSON request and response conventions
  • - Jump to errors, rate limits, and examples

Code examples on this page

  • - cURL: Yes
  • - JavaScript/TypeScript: Yes
  • - Python: Yes
  • - JSON request/response: Yes
  • - Config snippets: Yes
  • - Status labels: Live, Beta, Planned, Coming soon

Related docs

Last updated
2026-02-24

API overview

  • - API-first usage is a core HELVA CLOUD principle for automation and developer workflows.
  • - Current public docs are an active draft while endpoint inventory and auth methods are finalised.
  • - Current repo includes an internal ingestion endpoint pattern at /api/ingest/openclaw.
  • - Every endpoint page should include cURL, TypeScript, Python, JSON request/response, errors, and rate-limit notes.

Base URL and versioning (placeholder)

  • - Base URL (planned): https://helva.cloud/api/v1
  • - Versioning model (planned): version in path
  • - Endpoint lifecycle labels: Live, Beta, Planned, Coming soon
  • - Breaking changes will be published on /changelog with exact dates
Authenticated request (cURL placeholder)
bashPlanned
curl -X POST "https://helva.cloud/api/v1/workflows/execute" \
  -H "Authorization: Bearer hc_example_token" \
  -H "Content-Type: application/json" \
  -d '{
    "workflowId": "wf_example",
    "input": {
      "goal": "deploy-founder-mvp"
    }
  }'
Authenticated request (TypeScript placeholder)
tsPlanned
const response = await fetch("https://helva.cloud/api/v1/workflows/execute", {
  method: "POST",
  headers: {
    Authorization: "Bearer hc_example_token",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    workflowId: "wf_example",
    input: { goal: "deploy-founder-mvp" },
  }),
});

const payload = await response.json();
Authenticated request (Python placeholder)
pythonPlanned
import requests

payload = {
    "workflowId": "wf_example",
    "input": {"goal": "deploy-founder-mvp"},
}

resp = requests.post(
    "https://helva.cloud/api/v1/workflows/execute",
    headers={
        "Authorization": "Bearer hc_example_token",
        "Content-Type": "application/json",
    },
    json=payload,
    timeout=30,
)
print(resp.status_code, resp.json())
JSON response envelope (placeholder)
jsonPlanned
{
  "requestId": "req_123",
  "status": "accepted",
  "data": {
    "workflowRunId": "wfr_456",
    "state": "queued"
  },
  "error": null
}

Endpoint groups (documentation map)

  • - Authentication and identity (planned)
  • - Projects and environments (planned)
  • - Workflows and automation runs (planned)
  • - Integrations and provider connections (planned)
  • - Usage and analytics events (beta/internal patterns today)
  • - Webhooks and event subscriptions (planned)