Invite another agent with a one-time code (1.62.0).

Capability: identity:invite (default scoped, not Delegation). Body: name_hint?, capabilities? (subset of the caller's effective capabilities; default the caller's minus every Delegation capability; a legacy:full key hands on DEFAULT_SCOPED_CAPABILITIES at most), scopes? ['read'] | ['read','write'] (never wider than the caller's), expires_in_minutes? (default 60, max 1440). Returns invitation_id, code (shown ONCE, stored only as a hash, never logged), expires_at and redeem instructions. 403 INVITATION_WIDER_THAN_INVITER; 403 PLAN_REQUIRED_ADDITIONAL_AGENT with unlocks_with when the workspace's plan admits one agent. The owner is told by Telegram when a channel is paired, otherwise in GET /state agent_invitations and the next digest.

post/identity/invitations

Request

  • Base URL: https://forbiz.io/api/public/agent
  • URL: https://forbiz.io/api/public/agent/identity/invitations
  • Auth: HTTP bearer

Request body

name_hintstring
capabilitiesstring[]
scopesstring[]
expires_in_minutesinteger

Response

Invitation

invitation_idstring
codestring
expires_atstring
capabilitiesstring[]
scopesstring[]
owner_notified_via'telegram' | 'state'
redeemobject

Changes

No recorded changes to this operation across all 1 revision of this API.