Reference

Pairling Protocol Reference

The enforced paths between the iPhone and a paired Mac.

What this reference covers

Understand the boundary that this page documents.

This reference lists the paths that the Pairling Connect bridge permits. It is not a public integration API.

The allowed path list defines the bridge perimeter. It does not grant access to a request.

Access checks

Review the checks that remain active after the bridge accepts a path.

The bridge accepts a listed Pairling path only on a permitted tailnet host.

The Mac checks the bearer token and device scope for each request. It also verifies request proof before it performs the action.

Read Install and pair for the pairing flow and its security controls.

Pre-pair paths

Review the paths that the bridge permits before pairing is complete.

MethodPathPurpose
GET/health · /healthz · /readyz · /routez · /manifestCheck the Mac before pairing.
POST/pair/claim · /pair/psk-claimClaim a valid pairing.

Read paths

Review the paths that read state from the paired Mac.

GroupPathsPurpose
Health/health · /healthz · /readyz · /routez · /health-stream · /power-state · /statusRead runtime, route, and power state.
Sessions/sessions · /sessions-visible · /sessions-stream · /recent-projects · /filesystem/directories · /session-live-eventsList sessions, projects, directories, and live events.
Transcript/turn-state-stream · /transcript · /transcript-stream · /sessions/:id/exportRead turns, transcript text, and exports.
Terminal/terminal-stream · /terminal-stream-diagnostics · /terminal-surface-stream · /terminal-surface-v2 · /terminal-surface-stream-v2Read the supported terminal surfaces.
Truth/session-runtime-truth · /session-runtime-truth-stream · /terminal-workspace · /terminal-workspace-stream · /session-source-diagnosticsRead runtime and source evidence.
Catalog/commands · /commands-stream · /invocations · /invocations-stream · /activity · /activity-streamRead commands, invocations, and activity.
Workers/worker-stats · /workers · /orchestrations · /orchestrations/:id · /orchestrations/:id/streamRead worker and orchestration state.
Providers/provider-status · /providers/visibility · /aperture-cli/status · /aperture-cli/providers · /aperture-cli/launch-contextsRead provider and gateway state.
Settings/push/status · /prompt-presets · /prompt-presets/:slug · /pickers/resume · /pickers/resume/previewRead push, Prompt Preset, and resume state.
Pickers/pickers/permissions · /pickers/hooks · /pickers/memory · /pickers/memory/:file · /pickers/mcpRead coding CLI configuration.
PairDrop/pairdrop/files · /pairdrop/files/:id · /pairdrop/files/:id/content · /pairdrop/events · /pairdrop/uploads/:idRead file, event, and upload state.

Change paths

Review the paths that can change state on the paired Mac.

MethodPathsPurpose
POST/send-text · /terminal-control · /terminal-input · /sigint · /sigterm · /spawn-session · /uploadControl a coding session and upload an attachment.
POST/pair/revoke · /pair/rotate-token · /pair/bind-nodeChange a paired device.
POST/prompt-presetsCreate or change a Prompt Preset.
POST/providers/visibility · /pickers/permissions · /pickers/hooks · /pickers/memory · /pickers/memory/:fileChange coding CLI configuration.
POST/pickers/mcp/:name/restartRequest one MCP server restart.
POST/push/preferences · /push/test · /push/permission/allow · /push/live-activity-token · /push/live-activity-testChange or test push delivery.
POST/orchestrations · /orchestrations/:id/stopStart or stop an orchestration.
POST/pairdrop/files · /pairdrop/files/:id/attach · /pairdrop/uploads · /pairdrop/uploads/:id/complete · /pairdrop/maintenance/cleanup-partialsUpload, attach, finish, or clean partial files.
PUT/pairdrop/uploads/:id/bytesSend one resumable file chunk.
DELETE/pairdrop/files/:id · /pairdrop/uploads/:id · /prompt-presets/:slug · /pickers/memory/:fileDelete or mark the selected item.