Skip to main content

Glossary

Active workspace

The workspace currently selected in the web dashboard or mobile app. Invites, member lists, and many agent actions apply to this workspace until you switch workspace.

Approval Inbox

The home-style screen (mobile) or equivalent Approvals area (web) that lists your agents and how much pending work each has. You can search and filter to focus on agents that need attention.

Workspace

A shared space for your organization. Agents and API keys belong to a workspace. Users are owners or members.

Invite token

A secret string (or link-derived token) from a workspace invite that lets you join that workspace when pasted into the app’s join flow.

Agent

A logical automation that can raise approval requests. Each agent has an Agent ID used in API calls. You manage agents in the web dashboard and/or mobile app, depending on your workflow.

Approval request

A single question with context and options (and an expiry). The create response includes an external request_id (yours if you sent one, otherwise server-generated) for polling and correlation.

Subscriber

A workspace member who can receive push notifications when new approvals are created for a given agent. Configured per agent in the app (mobile push; web may show approvals without push).

Workspace API key

A secret key used with X-Api-Key together with X-Agent-Id. Generated by a workspace owner; shown in plain text only once when created (from the web dashboard or mobile app).

Callback vs polling

  • Callback — You provide a URL when creating the request; the service POSTs JSON to it when the approval is resolved (including timeout expiry). The body matches GET /v1/approvals/:requestId/result for a resolved request. See Callback webhooks.
  • Polling — Your automation repeatedly calls GET /v1/approvals/:requestId/result until the status is no longer pending.

Result delivery status

On metadata (GET /v1/approvals/:requestId), result_delivery_status tracks whether a callback completed successfully (delivered), failed after retries (failed), or is not applicable / still polling (pending). See Result delivery fields.

Timeout

Each request expires after the configured time. Behavior when time runs out depends on the timeout mode (for example, no action vs a predefined instruction).