Skip to content
Caprid

Relay and Switchboard docs

Relay carries live media and data over Media over QUIC, from publishers to subscribers, across regions. Switchboard decides who may publish and subscribe. These docs cover both, and the SDKs that connect your code to them.

Start the quickstartBrowse the API reference

Working with a coding agent? Point it at /llms.txt, or see Build with AI agents.

Start here

Section titled “Start here”
  • Overview
    How a publisher, a viewer and your backend fit together.
  • Quickstart
    From an API key to an object published and received, in five steps.
  • Core concepts
    Organizations, Namespaces, credentials, tracks and relays.
  • Build with AI agents
    llms.txt, Markdown for every page, and an agent skill.

Switchboard

Section titled “Switchboard”
  • Organizations and Namespaces
    Who owns what, and how to manage Namespaces, Members and Invitations.
  • Credentials
    API keys, Signing keys, Client tokens, and which goes where.
  • Prod and staging
    Keep staging in its own Namespace, with a key that can’t reach prod.
  • Self-hosted relays
    Run moq-relay yourself and enroll it in your Organization.
  • AI agents
    Let an AI agent start a Switchboard trial on its own, then claim it to keep what it built.

SDKs

Section titled “SDKs”
  • TypeScript
    @caprid/relay for browsers over WebTransport, and Node over native QUIC.
  • Python
    caprid-relay for asyncio, over native QUIC.
  • SDK specification
    The behavior contract both SDKs implement.

Reference

Section titled “Reference”
  • Account API
    Organizations, Members, Namespaces, keys, Client tokens and relays.
  • Relay plane API
    Enrollment, peer discovery and admission, as a relay calls them.
  • TypeScript API
    Every export of @caprid/relay and its companion packages.
  • Python API
    Every public name in caprid_relay, moq_core and moq_media.