Gateway Quickstart

Base URL: https://your-hyphen.example.com

All requests in this guide go to the gateway host. The gateway authenticates the key you provide, scopes the request to the correct org, and proxies runtime requests to Hyphen core.

1. Sign up

bash
curl -X POST https://your-hyphen.example.com/gateway/signup   -H "Content-Type: application/json"   -d '{
    "email": "ops@acme.com",
    "name": "Acme Ops"
  }'

Save:

  • management_token (mt-hyp-*)
  • api_key.key (sk-hyp-*)

These are shown only once.

2. Check account and orgs

bash
curl https://your-hyphen.example.com/gateway/account   -H "Authorization: Bearer mt-hyp-..."

This returns the account plus the orgs attached to it.

3. Create another runtime API key (optional)

bash
curl -X POST https://your-hyphen.example.com/gateway/orgs/:orgId/keys   -H "Authorization: Bearer mt-hyp-..."   -H "Content-Type: application/json"   -d '{
    "label": "prod-runtime",
    "permissions": "full"
  }'

Supported key scopes are:

  • full
  • read_only
  • execute_only

4. Execute a workflow through the gateway proxy

bash
curl -X POST https://your-hyphen.example.com/workflows/:id/execute   -H "Authorization: Bearer sk-hyp-..."   -H "Content-Type: application/json"   -d '{
    "input": {
      "invoice_id": "INV-001"
    }
  }'

The path is the normal runtime path, but you still send it to the gateway host. The gateway injects the org scope from the API key and forwards the request upstream.