Mint a device_code for an unauthenticated agent (RFC 8628-shaped)

Returns a device_code (agent-private) and a user_code (CHRM-XXXXXX, displayed to the user). Codes expire after 10 minutes. Agent then polls POST /api/pair/poll until status flips to approved. The legacy /pair/start path 308s here.

post/api/pair/start

Request

  • Base URL: https://charm.ing
  • URL: https://charm.ing/api/pair/start
  • Auth: none declared

Request body

labelstring

Optional human-readable label. Surfaced to the user on the approval page so they know which agent they’re connecting.

Response

Codes minted

device_codestring required

Agent-private — store securely, never display or log. Anyone with the device_code can poll for the token.

user_codestring required
verification_urlstring uri required
verification_url_completestring uri
polling_intervalinteger required
expires_ininteger required

Changes

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