โ–ฒ helio / docs

๐Ÿ”Search docsโŒ˜K

Home / Guides / Authentication

  • Getting started
  • Installation
  • Quickstart
  • Core concepts
  • Guides
  • Authentication
  • Webhooks
  • Rate limits
  • API reference
  • REST endpoints
  • GraphQL schema
  • CLI commands

[ Guide ยท Authentication ]

Authenticate your first request

Helio's API uses scoped API keys for authentication. Every request must include a bearer token; requests without one return a 401. This guide covers creating a key, scoping it, and making your first authenticated call.

Prerequisites ยท An active Helio workspace and a CLI installed (npm i -g @helio/cli).

Create an API key

From the workspace dashboard, open Settings โ†’ API keys and click Create key. Give it a descriptive name (we use the app name) and pick the scopes it needs. Keys are never shown twice โ€” copy it into your secret manager right away.

$ helio keys create --name staging-api --scope read:orders,write:webhooks
# โ†’ creates a scoped bearer token
helio_live_sk_7fC9d2aK3vN8qY4xM1pR6zB0jL

Make your first request

Pass the key in the Authorization header. A successful call returns 200 OK with the current workspace.

$ curl https://api.helio.dev/v1/workspace \
    -H "Authorization: Bearer $HELIO_KEY"

# โ†’ 200 OK
{
  "id": "ws_7fC9d2aK",
  "name": "Staging",
  "plan": "team"
}

Rotate keys safely

Every key supports overlap windows โ€” create a new one, deploy it alongside the old one, and revoke the old key once traffic has moved. The dashboard shows last-use timestamps so you know when a key is safe to retire.

On this page

  • Create an API key
  • Make your first request
  • Rotate keys safely
Close-up of a circuit board with a central processor and copper coils
โ† Previous

Core concepts

The small set of nouns every Helio integration speaks.

Engineer working at an automation line
Next โ†’

Webhooks

Receive events at your own endpoint with verified signatures.