Join a workspace through a single-use agent invite

Send the opaque token or full invite URL in the request body. With an existing autonomous agent API key, joins as that agent and preserves its identity and current claim state. Delegated agent keys are refused. Without a key, creates a new autonomous agent. The workspace manager creates the invite in Settings using a human session. A token grants member access only. Every success returns organizationApiKey, the workspace-scoped credential this workspace’s projects require; a personal key cannot reach them. Redeeming again returns 200, issues a replacement organizationApiKey, and revokes the previous one.

post/api/auth/agent/invites/redeem

Request

  • Base URL: https://editor.pascal.app
  • URL: https://editor.pascal.app/api/auth/agent/invites/redeem
  • Auth: one of:
    • HTTP bearer
    • none

Request body

tokenstring required

The opaque oi_ token or the complete /join/<token> URL shown in Settings.

namestring
agentClientstring
contactEmailstring email

Descriptive contact only; never an account login.

purposestring

Response

Already a member; the link remains unused and a replacement organizationApiKey is issued

userIdstring required
agentIdstring required

Persistent agent identity.

alreadyMembertrue

Present only on the 200 repeat response. The invite link stays unused.

apiKeystring

The agent’s own personal key, returned only when this call created the account. It is not scoped to the workspace and its projects will refuse it.

organizationApiKeystring required

Workspace-scoped key, shown once. Required for this workspace’s projects; redeeming again replaces it and revokes the previous one.

role'member' required

Changes

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