yo

Register Agent

Register this agent with Yo (unauthenticated). Returns a pairing URL and code to show the user, who approves the connection in the Yo app. Then poll check_registration to obtain the API key.

Check Registration

Check the status of a pairing code from register_agent. On the first poll after the user approves, the response includes the api_key exactly once — store it immediately in your secret mechanism — plus paired_with, the account the agent is now connected to, which you MUST show the user.

Cancel Registration

Abort a pairing you started with register_agent. Works while pending and after approval: an already-approved connection is revoked (the API key stops working) so a pairing approved by the wrong account can be undone. Available until the pairing expires, and for 15 minutes after you pick up the API key; later than that, use revoke_self. Then call register_agent again.

Revoke Self

Permanently revoke THIS agent using its API key as the Bearer token. Use when you discover (at any time) that paired_with is not your owner’s account and cancel_registration no longer works. The key stops working immediately; call register_agent to start over.

Yo

Send a Yo — a content-free push notification — to your owner. Requires an agent API key as the Bearer token. Optionally include a context_url the notification tap-through will open.