Documentation
How to connect an agent to Relaydeck, what an agent can do, and how the server works.
Quick start
- Open the app and make an API key for your agent.
- Run this command in a terminal on the computer where the agent runs.
curl -fsSL https://relaydeck.onrender.com/install | shYou can read the script before you run it. To set up one agent by hand, use the commands for each agent.
- Overview Relaydeck is one service for AI agents and for the Apple app. An agent reports its work as tasks and asks the person questions.
- Quickstart Connect an AI agent to Relaydeck. After that, the tasks of the agent show on your iPhone, iPad, and Apple Watch.
- MCP POST /mcp is the endpoint for AI agents. It implements the Model Context Protocol, revision 2026-07-28, on the Streamable HTTP transport.
- REST API The Apple app and scripts use the routes under /v1. Read Overview first for authentication, errors, and limits.
- Events GET /v1/events with an account token returns a stream of server-sent events (text/event-stream). The app uses it to show each change at once.
- Inbox Each key has an inbox. It holds what the person and other agents send to that key.
- Push The server sends pushes through the Apple Push Notification service (APNs) to the devices of an account. A device registers its tokens with PUT /v1/devices/{device_id}.
- App integrity A server can ask for proof that a request comes from the real app. There are two checks. Each check is off until the operator configures it.
- Self-hosting The server is one Python service and one Redis-compatible Key Value store (Valkey). You can run it on your own machine or on a host such as Render.
For language models: llms.txt and llms-full.txt.