PingRoom

Verify the current connection: owner.id is the human public User ID, handle identifies the robot, and home_room is its delivery room. After login or reconnect, match owner.id and handle to the approve…

Revoke this authenticated robot connection, including its access and refresh credentials and room memberships. Use only when the human explicitly requests logout, disconnection, or reconnection. Call …

List the rooms the authenticated account belongs to.

List the quick actions configured for a room.

Press a room quick action, notifying its members. Rate-limited. Read the action's input_type first (list_quick_actions): location needs data.location, link needs data.url, file/photo/pdf need attachme…

Send a custom ping to a room the account belongs to. Pass data.checklist.items to send a checklist the room ticks through together; read the ticks back as checklist_state. Rate-limited. In someone els…

Start, update, or end a live progress card on the room members' lock screen (an iOS Live Activity / Android live update). Reuse the same correlation_id for every ping of one stream: the first ping sta…

Read back the current state of a live stream you created, so a restarted producer can reconcile instead of starting a duplicate. Only returns streams started by this credential, within the last 24 hou…

Act on a "Who's on it?" request (a live_status stream with template "claim") as your human: "claim" takes an open request (anyone but its asker), "release" lets go of one you hold, "done" finishes it …

List the room-icon catalog (icon ids, tags, and categories). Call this before create_room / create_public_room / create_webhook to pick a valid icon id, and to interpret icon values returned by reads.

List a bounded page of recent pings across approved rooms, newest first. Use page to continue while has_more is true.

Fetch one visible ping by notification id, including its current action_state and, once anything on its data.checklist is checked, checklist_state.

Long-poll for the next ping. Blocks until one arrives or the timeout elapses — the real-time inbound channel for an agent. Excludes everything your connected human sends (and your own sends); you rece…

Long-poll a generic acknowledgement-required ping until its confirmation rule is met (any: first confirmation; all: every original eligible recipient), it expires, or the timeout elapses. Questions us…

Ask the human to approve or reject an action, then block on their answer (pair with wait_for_approval). Delivered as a push to the connected human only, so like a direct ask_question to them it needs …

Long-poll an approval request until the human decides or it expires. Returns the status and, once decided, the chosen option.

Fetch the current status of an approval request without blocking.

Ask a person a question with 2-4 tappable options, then block on their answer (pair with wait_for_answer). Delivered as a push they can answer from the lock screen or in-app; the first valid answer wi…

Long-poll a question until it is answered or expires. Returns the state and, once answered, the chosen option value + label and the responder.

Fetch the current state of a question without blocking.

List a bounded page of questions you asked, newest first. Optionally filter by state; use page while has_more is true.

Withdraw a still-pending question you asked.

Start or resume the onboarding Question in the private room the human chose during authorization. If recipient_not_ready, ask the human to install or update PingRoom from install_url, open the app, si…

Hand work to exactly one human as either an acknowledgement or a tappable question. The server verifies that one of the recipient's current devices supports the complete Handoff action before creating…

Long-poll a Handoff until the human resolves it, it expires, or the bounded timeout elapses. For the onboarding Question returned by activate_agent_inbox, success requires an answered result with acti…

Fetch the authoritative current state of one Handoff without blocking.

List a bounded page of this agent's Handoffs, newest first. Omit state (or use open) for unresolved work; use all for history and page while has_more is true.

Upload a small file (max ~90 KiB over MCP; Pro account required) and get an attachment id to include in broadcast or ask_question via attachment_ids. Larger files: use the PingRoom CLI or agent REST A…

Fetch an attachment visible to this agent as base64 content plus metadata. Results over the connector size limit return attachment_too_large — fetch those via the agent REST API instead.

Delete an attachment this agent uploaded that is not yet claimed by a ping.

Fetch a single room by its invite code, including members and quick actions.

Create a new private room owned by the authenticated account. Free accounts may own up to five rooms. If this agent was granted every room and has no delivery room yet, the new room becomes its delive…

Create a publicly discoverable room with a unique @handle. Counts toward the free-plan five-room cap.

Join a room using its invite code. Include the password only if the room is protected.

List the incoming webhooks (with their trigger URLs) for a room the account owns.

Create an incoming webhook for a room the account owns. The bound account must be Pro. Returns the secret trigger URL — treat it as a credential.

Update an incoming webhook (by id) on a room the account owns — e.g. change its icon, title, message, or sound.

Delete an incoming webhook (by id) from a room the account owns.

Configure a numbered quick-action slot for a room the account owns. Sends a background room refresh to room members' devices.

Configure several of a room's quick-action slots in one call. Prefer this over repeated update_quick_action: each single-slot write wakes room members' devices with its own background refresh, so sett…

Set this agent's avatar. Must be one of the PingRoom bot avatars.

Rotate this agent's public handle — kill-switch for a leaked handle.