快速开始

在控制台注册,复制 API Key(ab_…),然后创建收件箱并发送。

curl -X POST https://voru.org/v1/inboxes \
  -H "X-API-Key: ab_..." \
  -H "Content-Type: application/json" \
  -d '{"display_name":"support-bot"}'

curl -X POST https://voru.org/v1/inboxes/<id>/messages/send \
  -H "X-API-Key: ab_..." \
  -H "Content-Type: application/json" \
  -d '{"to":"you@example.com","subject":"Hello","text":"Hi","labels":["outreach"]}'

完整可交互文档(试调用、模型、鉴权): /v1/docs · openapi.json

API 一览

鉴权

控制台登录拿 JWT;自动化用 X-API-Key: ab_…。必须由人注册,Agent 不能自助开户。

  • POST /v1/auth/register — 发确认邮件
  • POST /v1/auth/verify 与 /verify/resend
  • POST /v1/auth/login · /forgot · /reset(登录可带 X-Device-ID)
  • GET /v1/auth/devices — 已登录设备列表
  • DELETE /v1/auth/devices/{id} — 踢下线(撤销该设备 JWT)

工作区

当前套餐、限额、用量。

  • GET /v1/me
  • GET /v1/overview
  • GET /v1/metrics
  • GET /v1/plans
  • GET /v1/mail/status

收件箱与邮件

一客户一地址。发送、回复、线程、附件、搜索、标签。

  • POST/GET/PATCH/DELETE /v1/inboxes
  • GET /v1/inboxes/{id}/credentials — IMAP 1993 / SMTP 465
  • POST .../messages/send · reply · reply-all · forward
  • GET .../messages · /search · /{id} · attachments
  • GET /v1/threads/{id}
  • POST/GET/PATCH/DELETE /v1/drafts POST .../send

事件

HTTPS Webhook(HMAC 头 X-AgentBox-Signature)或 WebSocket。

  • POST/GET/PATCH/DELETE /v1/webhooks POST .../test
  • WS /v1/ws — 用 API key 订阅
  • 事件:message.received/sent/delivered/bounced/complained/rejected、domain.verified

多租户、域名、密钥

Pod 隔离客户;付费档绑自己的域。

  • POST/GET/DELETE /v1/pods · .../inboxes
  • POST/GET/DELETE /v1/domains POST .../verify
  • GET/POST/DELETE /v1/lists/allow|block
  • POST/GET/DELETE /v1/api-keys POST /v1/inboxes/{id}/api-keys

计费与工单

付费走 Stripe Checkout。工单会发邮件通知。

  • POST /v1/billing/upgrade — 返回 checkout_url 或直接改档
  • POST /v1/billing/stripe — Stripe Webhook
  • POST/GET /v1/tickets POST .../messages

外发邮件

外发从 agent.voru.org 送出。IMAP 为 agent.voru.org 端口 1993,SMTP 465。创建收件箱后 GET /v1/inboxes/{id}/credentials 返回邮箱密码。

事件

message.received / sent / delivered / bounced / complained / rejected / domain.verified。签名头 X-AgentBox-Signature。

真正生效的限额

外发邮件

快速开始 — AgentBox