relay
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseRelay v1
Relay v1
Use the locked contract, not memory.
请以锁定的 contract 为准,不要凭记忆推断。
Route
路由
- Contract, routes, fields, events: read the locked reference and the
locked first. Report hash or source drift.
contracts/relay-v1-openapi.yaml - Messaging, buttons, list pickers, rich cards, carousels, forms, payments, places, threads and voice memos: read messaging.
- Chats, contacts, sharing a card, person fields and chat activity: read chats and contacts.
- Audio and video calls, call events, and Pipecat, LiveKit or avatar integrations: read calls.
- , who can message the agent, Log in with Relay, and the hosted MCP server's tools: read agent settings.
GET /v1/me - Searching the public agent directory: read directory.
- Webhooks, WebSocket, ACK, replay, and sync: read agent events.
- Tokens, environments, retries, errors, and the TypeScript and Python SDKs: read SDK and auth.
- CLI setup, profiles, connection, sending any message part, other resource commands, or skill installation: read CLI and skills.
Read only the reference needed for the task. Use docs MCP for discovery when
available; the lock and OpenAPI remain authoritative.
- Contract、路由、字段、事件:先阅读锁定的参考文档以及锁定的 。报告 hash 差异或源码漂移。
contracts/relay-v1-openapi.yaml - 消息、按钮、列表选择器、富媒体卡片、轮播卡片、表单、支付、地点、线程和语音留言:阅读消息。
- 聊天、联系人、分享卡片、人员字段和聊天活动:阅读聊天与联系人。
- 音频和视频通话、通话事件,以及 Pipecat、LiveKit 或 avatar 集成:阅读通话。
- 、谁可以向 Agent 发送消息、通过 Relay 登录,以及托管 MCP 服务器的工具:阅读Agent 设置。
GET /v1/me - 搜索公开 Agent 目录:阅读目录。
- Webhooks、WebSocket、ACK、重放和同步:阅读Agent 事件。
- Token、环境、重试、错误,以及 TypeScript 和 Python SDK:阅读SDK 与认证。
- CLI 设置、profiles、连接、发送任意消息部分、其他资源命令或安装 skill:阅读CLI 与 skill。
仅阅读任务所需的参考文档。可用时,使用 docs MCP 进行发现;lock 和 OpenAPI 仍为权威来源。
Rules
规则
- Never invent a route, field, event, package, migration, or product rule.
- Mark behavior not proven by the contract or repository as .
unknown - Prefer for TypeScript and
@relaymessenger/sdkfor Python; show cURL for HTTP examples.relaymessenger - Keep Agent Tokens in trusted backend storage and use credentials from the matching environment.
- For integration changes, test the real boundary: signatures over raw bytes, durable commit before ACK/2xx, duplicate events, idempotent replies, reconnect/replay, and relevant direct/group messages.
- 绝不要臆造路由、字段、事件、依赖包、迁移或产品规则。
- 对于 contract 或代码仓库未能证明的行为,请标记为 。
unknown - TypeScript 优先使用 ,Python 优先使用
@relaymessenger/sdk;HTTP 示例中使用 cURL 展示。relaymessenger - 将 Agent Token 保存在可信的后端存储中,并使用匹配环境中的凭据。
- 对于集成变更,应测试真实边界:基于原始字节的签名验证、在 ACK/2xx 前完成持久化提交、重复事件、幂等回复、重连/重放,以及相关的私聊/群聊消息。
Rating requests
评分请求
To ask a person to rate your agent, send only as
the message part. Read ratings for TypeScript, Python,
CLI and bridge examples and , , .
Do not call person-only rating endpoints with an Agent Token.
{"type":"rating_request"}rating.createdrating.updatedrating.deleted如需请用户为 Agent 评分,消息部分只能发送 。有关 TypeScript、Python、CLI 和 bridge 示例,以及 、、,请阅读评分。
{"type":"rating_request"}rating.createdrating.updatedrating.deleted不要使用 Agent Token 调用仅限用户调用的评分端点。