Skip to main content

​
API keys & connecting automations

Automations (n8n, Zapier, scripts) call the Agent API using two values from the web dashboard or mobile app:
  1. Agent ID — identifies which agent is creating approvals.
  2. Workspace API key — authenticates your team. Keys are created at the workspace level and work with any agent in that workspace.

​
Where to find them

​
Mobile

Open an agent, then go to Credentials (or the screen that shows integration credentials).

​
Web

Open Quickstart Integration for a guided flow, or Workspace (Integrations in the sidebar) for workspace keys, or an agent’s detail screens for Agent ID and related settings—follow the labels in the web dashboard.

​
Agent ID

The product displays the Agent ID (UUID). Copy it—you will send it on every API request as the X-Agent-Id header.

​
Workspace API key

  1. Use Generate API key (only workspace owners can create keys).
  2. The plaintext key appears once after generation. Copy it immediately and store it in a password manager or your automation’s secret store.
  3. Pass the key as the X-Api-Key header on each request.
If you lose the key, generate a new one and update your automations. Old keys can be revoked from workspace key management when your deployment supports it.

​
Required HTTP headers

Most Agent API requests must include:
HeaderValue
X-Agent-IdYour agent’s UUID
X-Api-KeyThe full workspace API key (plain text, only shown at creation)
Exception: GET /v1/agents uses X-Api-Key only (no X-Agent-Id) to list agents for the key’s team. See the Agent API. Use your deployment’s base URL (for example https://api.example.com) with paths such as POST /v1/approvals. Your administrator or onboarding materials supply the exact base URL. The official Zapier integration in this repo targets https://api.finalsay-hitl.com and does not ask for a base URL.

​
Next steps