API 参考

用量与指标

用 GET /v0/usage 查看每日用量、当前配额和熔断状态，以及事件、用量和比率的指标接口。

docs.simail.ai/zh/api/usage

用量

GET/v0/usage

权限 usage_read。查询参数 from 和 to（日期，YYYY-MM-DD，UTC；默认最近 7 天）。

{
  "organization_id": "org_01JZX3S5V7W9X1Y3Z5A7B9C1D3",
  "days": [
    { "date": "2026-10-18", "received": 41, "sent_messages": 12, "sent_recipients": 14, "bounced": 0, "complained": 0, "storage_bytes": 18734120, "api_calls": 2210 }
  ],
  "quotas": {
    "inbox_limit": 10,
    "daily_recipients": 100,
    "daily_recipients_used": 14,
    "api_calls_daily": 50000
  },
  "breaker": { "state": "ok", "reason": null, "bounce_rate_7d": 0.0, "complaint_rate_7d": 0.0 }
}

breaker.state 为 ok 或 tripped。为 tripped 时，reason 说明原因（例如 message.bounced），发信保持暂停，直到人恢复。见熔断。计数从不包含邮件内容。

MCP：get_usage 返回同一个对象，包括熔断原因。

指标

GET/v0/metrics/events

GET/v0/metrics/usage

GET/v0/metrics/rates

权限 usage_read。给图表和告警用的时间序列：按类型的事件计数、按天的用量计数，以及发送、退信和投诉比率。每个接口都接受 from、to，适用时还有 types。邮箱和 pod 变体（/v0/inboxes/{inbox_id}/metrics/…、/v0/pods/{pod_id}/metrics/…）会把序列收窄到那个范围。