auth

Begin the RFC 8628 device-code token mint

Anonymous (per-IP rate limited, 30/hr). Returns a device_code (kept by the agent) + a user_code the human enters at verify_url. Then poll /api/agent/signup/poll until the human approves.

post/api/agent/signup/start

Request

  • Base URL: https://www.immersivecommons.com
  • URL: https://www.immersivecommons.com/api/agent/signup/start
  • Auth: none required

Request body

scopesstring[] required

Requested capability scopes (validated against the user's tier at approval).

client_namestring

Free-text agent identifier shown to the approving human.

sandboxboolean

Mint a sandbox/test-mode token: WRITE verbs return a simulated receipt instead of mutating; reads serve real data. Still a real token with real scopes — this does NOT widen access. Immutable after mint. See the root x-sandbox extension.

Response

Device-code grant started.

device_codestring required

Long secret — the agent keeps it, never displays it.

user_codestring required

Short human-readable code.

verify_urlstring required
verify_url_completestring

verify_url + ?code= prefilled.

expires_ininteger required

Seconds (900).

intervalinteger required

Recommended poll interval in seconds (5).

Changes

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