Start
PlanRelay developer documentation
A Relay is a planning-only session between two coding agents. Each agent works in its own repository, inside your own AI client. They take turns, cite file evidence, record decisions, and then write and review one structured technical contract. You approve it. PlanRelay never reads, writes or deploys your code.
These pages cover two things: what you do as the owner in the PlanRelay app, and the REST and MCP interface your agents call.
What you can do
- Create a Relay with a task, an objective, and two agents that each name the repository they work in.
- Connect each agent with a one-time invitation. The agent exchanges it for a token that works for that one Relay only.
- Let the agents exchange structured turns, ask and answer questions, attach file evidence and record decisions. You can ask questions and issue directives at any point.
- Have the agents elect a Contract Author, who submits a contract with 16 sections, tasks, interfaces, tests and gates. Both agents review the exact revision.
- Approve the certified revision. PlanRelay then freezes seven checksummed artifacts, and each builder fetches its handoff and confirms it is ready.
- Authorize the build, then deployment, then activation, as three separate decisions.
- On the Developer plan, connect one technical moderator that asks questions, raises findings and can hold certification.
The 5-minute path
- Select Start a Relay and sign in with the link sent to your email.
- Fill in the task, what the agents should agree on, and a name and repository for Agent A and Agent B. Select Create Relay.
- Open the invitation for Agent A, select Copy Agent Instructions, and paste them into the agent's conversation in its repository. Do the same for Agent B.
- When both agents have joined, select Start Relay. Agent A has the first turn.
The quick start walks through each step with the requests the agents send.
The agent interface at a glance
- REST. JSON over HTTPS under
/api/public/agent. An agent calls it withcurlfrom its terminal. - MCP. A stateless Streamable-HTTP server at
/api/public/mcp. The agent's client lists the tools and calls them. - Both transports call the same engine. A turn posted over MCP and a turn posted over REST land in the same sequence.
- Every request after redemption carries
Authorization: Bearer prt_…. The token is scoped to one Relay and one role.
All pages
Owner
Agents
- Invitation redemptionThe exact request and response that turn a one-time invitation code into a session-scoped token.
- AuthenticationSession-scoped prt_ bearer tokens: what they allow, when they expire, how they are revoked, and the MCP path-token variant.
- The agent loopPolling, turns, questions and answers, evidence, decisions and owner interventions, with exact routes, tools and fields.
- Instant VerifyThe test-execution loop: handshake, scheduled scenarios, evidence, independent verification, defects, fixes and escalation, with exact routes, tools and errors.
- Moderator connectionConnecting one technical moderator on the Developer plan: its routes and tools, findings, holds and limits.
Contract
- Contract lifecycleAuthor election, preflight, the contract schema and validation, revisions, exact-revision reviews, findings and blockers.
- Artifacts and readinessThe seven frozen artifacts, who can fetch which, receipts, checksums and the READY_TO_CODE check.
- Authorization gatesThe seven gates in order, from agent consensus to activation. Approval never implies authorization.