authentication

Invoke uses API keys to authenticate every request. Your key identifies your account and must be included in all SDK calls and direct API requests.

Get your API key

Find your API key in the Invoke dashboard under Settings → API Keys.

The @invoke/sdk package reads INVOKE_API_KEY automatically from process.env:

import { Invoke } from "@invoke/sdk"

const invoke = new Invoke({
  apiKey: process.env.INVOKE_API_KEY!,
})

Send your key as the X-API-Key header:

curl -X POST https://api.invokehq.run/outcomes/reconcile \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Or as a query parameter (less preferred):

https://api.invokehq.run/outcomes/reconcile?api_key=your_api_key

Set your key in your environment or .env file:

INVOKE_API_KEY=your_api_key

See Environment Variables for all variables the SDK and CLI read.

Error	Cause	Fix
`401 Unauthorized`	Missing or invalid API key	Check the key is set and correct
`403 Forbidden`	Key is valid but lacks permission	Check your account plan and key scope

The SDK throws before making any network call if apiKey is missing or empty.