Mailzeroドキュメント

常設委任を一覧表示

オーナーの常設委任ルールを順番に表示: 名前、マッチ述語、担当者 (エージェントアイデンティティまたはワークスペースメンバー)、自律性レベル、各マッチ回数。assistant:read が必要です。エージェントトークンは拒否されます。

常設委任を作成

案件の種類をエージェントまたは人に一度引き渡します。match は明示的な述語であり、モデル呼び出しではありません: senderAddress, senderDomain, organisation, workKeyPrefix, senderKind, mailboxIds, labels, subjectPattern (アンカー付き、大文字小文字を区別しない), minOccurrences、minConfidence（校正済み分類器が category: ラベルに付けた確率、0.5 から 1） のいずれか。記載されたすべての条件が成立する必要があります。ルールは順序付けられており、最初にマッチしたものが適用されます。レベルは特に指定がない限り observe です。マッチするルールは次のマッチするアイテムを担当者に引き渡し、委任通知を通じて伝え、Today が理由を表示します。assistant:write が必要です。エージェントトークンは拒否されます。

常設委任を変更

名前変更、有効化または無効化、並べ替え、マッチ、担当者、レベルまたは付与の変更。レベルを observe に下げることは、ルールのワンクリック停止スイッチです。assistant:write が必要です。エージェントトークンは拒否されます。

常設委任を削除

ルールを削除します。引き渡されたアイテムはオーナーに戻り、担当者が行ったことの記録は残ります。assistant:write が必要です。エージェントトークンは拒否されます。

サンプルの事実で常設委任を試行

模拟运行：哪条规则会处理具有这些事实（邮箱、键、发件人、主题、标签、出现次数）的事项，以及原因。不会更改任何内容。需要 assistant:write；智能体令牌会被拒绝。

既存の委任のレベルと権限に対して効果を試行します

今日ルールの下でリクエストされた効果の検証順序のドライラン: レベルが種類を許可するか; 権限が受信者、ボリューム(今日実行された効果の数)、スケジュール、支出、案件から読み取られたリスククラスを許可するか; 必須の承認者が承認したか。プランが取る状態(proposed、approved、escalatedまたはrejected)をすべてのチェックとその理由とともに返します。何も変更されません。assistant:writeが必要です; エージェントトークンは拒否されます。

タスクメトリクスを読み取る

ローリングウィンドウ(デフォルトで30日、window_daysは1から90)上のタスクレイヤーの7つの数値、アカウント全体および各常設委任について: オーナーなしでクローズされた案件、到着から完了までの時間、提案通りに実行されたプラン、編集および却下されたプラン、案件あたりのエスカレーション、実行後の修正、衝突、案件あたりのモデルコスト。レシート、プラン、エスカレーション、台帳から読み取られます。推定値は含まれません。assistant:readが必要です。

承認キューを取得

オーナーを待っているプラン(ドラフトで提案されたもの、または権限によって保留されているもの)と、担当者が尋ねた質問(閲覧者が見ることができる案件全体)。作業項目のインタラクションを通じて回答: プランを承認または却下、質問に対してオプションを選択または指示。assistant:readが必要です。認証メールがアシスタントから除外される前にそのメールから作られた案件は、email:auth_secrets のない閲覧者には、タイトル、要約、依頼内容、プランの効果を伏せた状態で表示されます。

委任提案を一覧表示

アシスタントが提案する常設委任：90日間に少なくとも3回繰り返された案件（同じ組織または送信者）で、毎回同じ方法で処理されたもの（ignored、answered、closed、1人のエージェントにhanded）。ルールは事前入力されています。デフォルトでは未処理のもの。オーナーが承認するまで何も作成されません。assistant:readが必要です。エージェントトークンは拒否されます。

委任提案を承認または却下

承認：提案が閉じられ、事前入力されたルールがクライアントに返されて作成されます（POST /api/assistant/rules）。却下：提案が閉じられ、同じ案件と処理方法に対して二度と表示されません。assistant:writeが必要です。エージェントトークンは拒否されます。

担当者に付与された権限をリストします

オーナーのエージェントとメンバーに付与された権限。案件を割り当てるすべてのルールに加えて適用されます; ルールと担当者のうち、より厳格な方が適用されます。assistant:readが必要です; エージェントトークンは拒否されます。

担当者の権限を設定します

エージェントIDまたはワークスペースメンバーに権限を付与します; これらは担当者の以前の権限を置き換え、案件を割り当てるすべてのルールに上限を設定します。assistant:writeが必要です; エージェントトークンは拒否されます。

担当者の権限を削除します

担当者は各ルールが付与するもののみを保持します。assistant:writeが必要です; エージェントトークンは拒否されます。

タスクエンベロープを読み取る

担当者が必要とするmatter: 証拠を含むbrief、facts、delegation(担当者、ルール、レベル、許可された効果の種類、有効な権限)、進行中および最近のplans、lease。agentトークンは自身に割り当てられたmatterと操作するメールボックスのmatterを読み取ります; オーナーは自分自身のものを読み取ります。assistant:readが必要です。認証メールがアシスタントから除外される前にそのメールから作られた案件は、email:auth_secrets のない閲覧者には、タイトル、要約、依頼内容、プランの効果を伏せた状態で表示されます。

タスクのleaseを取得または更新する

2人の担当者が1つのmatterを同時に作業することはありません: leaseは誰がいつまで作業するかを指定します(デフォルトで15分、最大1時間)。再度取得すると更新されます; 別の保持者は期限までTASK_LEASEDで拒否されます。効果リクエストは自動的にleaseを取得します。assistant:writeが必要です。

leaseを返却する

呼び出し元が保持しているleaseを解放します; 別の担当者が保持しているleaseはそのままにされます。assistant:writeが必要です。

タスクに対する効果を要求する

担当者は1つ以上の効果(reply、forward、label、snooze、resolve、note、request)を要求します。delegationのレベルが許可される種類を決定し、権限がそれらを制限します: guarded_sendまたはoperate(およびtriageでのインバウンド種類)の権限内では、効果はレシートと共にすぐに実行されます; draftではオーナーの承認を待ちます; 権限チェックの失敗はオーナーにエスカレートされます; レベルが許可しない種類は拒否されます。オーナー自身のリクエストはすぐに実行されます。同じidempotency keyは最初のplanを再度返します。assistant:writeが必要です。

停止してオーナーに尋ねる

アサイニーは証拠とともに質問をし、有用な場合は見えている選択肢を示します。オーナーはこれによって作成される決定に対して通常のchooseまたはinstructインタラクションで回答します。案件はTodayでオーナーを必要としていると表示され、リースは解放され、タスクは待機します。assistant:writeが必要です。

タスクについて報告する

アサイニーが行ったことと結果:done(案件が解決するか、回答がまだ期待されている場合は待機)、blocked(オーナーに尋ねる)、またはhanded back(オーナーが引き継ぎ、ルールはこの案件から外れる)。クレームはプラットフォームが書いたレシートと照合されます。レシートのないクレームはクレームとして記録され、決して事実としては記録されません。リースは解放されます。assistant:writeが必要です。

アシスタントがメッセージについて確立した内容を読む

このメッセージの分析が生成した知識: 主張 (subject, predicate, value with type and currency, basis, confidence, validity, evidence)、エンティティ、コミットメントと期待。途中で何も計算されません: パイプラインが分析していないメッセージは analysed: false と reason で応答します (not_enabled はメールボックスがアシスタントに含まれていない場合、not_analysed は分析がまだ行われていない場合)。assistant:read が必要です。

独自のスキーマでメッセージから必要なフィールドを抽出

メッセージテキスト (subject, sender, body) に対する1回のモデル呼び出しで、呼び出し元の JSON スキーマ (オブジェクトとプリミティブ、最大 8 KB、参照なし) を使用: その形式で data、confidence (0 から 1)、evidence_quotes (逐語的な抜粋) を応答します。(message, schema, instructions) でキャッシュされるため、同じ質問は1回の呼び出しでコストがかかります (その後は cached: true)。アカウントのモデル予算によって制限されます (使い切った場合は 429、モデルルートがオフの場合は 503)。サインインコードメールは 403 AUTH_MESSAGE を応答します。60,000 文字を超える本文は 413 を応答します。

Mailzero アシスタント設定を取得

アシスタントのオプトイン状態、shadow/pause フラグ、同意バージョン、プライバシールート、メールボックススコープ、および所有するすべてのメールボックスを返します。assistant:read のアクセス許可が必要です。

{
  "enabled": false,
  "shadow_enabled": true,
  "paused": false,
  "mailbox_ids": [
    "mbx_123"
  ],
  "history_window_days": 30,
  "privacy_route": "private_cloud",
  "attachment_vision": false,
  "pipeline_version": "communication-analysis.v1",
  "consent": {
    "required_version": "mailzero-personal-ai.v1",
    "accepted_version": "mailzero-personal-ai.v1",
    "accepted_at": "2026-09-02T09:12:00.000Z"
  },
  "mailboxes": [
    {
      "id": "mbx_123",
      "slug": "hello",
      "domain": "example.com",
      "name": "Hello",
      "kind": "api",
      "address": "hello@example.com"
    }
  ]
}

Mailzero アシスタント設定を更新

アシスタント処理を明示的に有効化、一時停止、再開、またはスコープ設定します。mailbox_ids: [] を送信すると、すべてのメールボックスが無効化され、実行中の履歴インポートがキャンセルされます。再開には現在の同意バージョンが必要です。メール受信は独立して動作します。assistant:write のアクセス許可が必要です。

{
  "ok": true,
  "enabled": true,
  "shadow_enabled": true,
  "paused": false,
  "mailbox_ids": [
    "mbx_123"
  ]
}

同意してバックグラウンド履歴インポートを開始

現在の明示的なAI同意を記録し、選択されたユーザー所有のメールボックスでシャドウ処理を有効にし、最近の履歴の再開可能なバックグラウンドインポートを作成します。クライアントは直ちに終了してGET /api/assistant/backfillをポーリングできます。assistant:writeスコープが必要です。

{
  "ok": true,
  "preview": {
    "mailbox_ids": [
      "mbx_123"
    ],
    "history_window_days": 30,
    "scanned": 0,
    "enqueued": 0,
    "capped": false,
    "background": true,
    "backfill_id": "bf_456"
  }
}

バックグラウンド履歴インポートの進捗を取得

スキャン/分析フェーズ、処理済みメッセージと総メッセージ数、パーセンテージ、適応型ETA、一時停止状態、およびアプリを終了できるかどうかを返します。assistant:readスコープが必要です。

{
  "backfill": {
    "id": "bf_456",
    "status": "processing",
    "phase": "analysis",
    "paused": false,
    "processed": 12,
    "total": 40,
    "failed": 0,
    "percent": 30,
    "estimated_seconds_remaining": 240,
    "estimated_completion_at": "2026-09-02T09:20:00.000Z",
    "can_close_app": true,
    "started_at": "2026-09-02T09:12:00.000Z",
    "completed_at": null
  }
}

失敗した履歴インポートメッセージを再試行

AI有効のままのメールボックスについて、最新のインポートからの最終的な失敗を再キューイングします。メッセージがここに表示される前に、自動再試行はすでに使い果たされています。assistant:writeスコープが必要です。

{
  "ok": true,
  "retried": 2
}

グラウンディングされたTodayの決定キューを取得

バージョン管理された Now、Needs you、Waiting、Upcoming、および最近の Handled プロジェクションを as_of、lag、coverage、warnings とともに返します。各項目はソースメッセージにリンクしており、ここではメールは送信されません。assistant:read のアクセス許可が必要です。認証メール (サインインコード、パスワードリセット、マジックリンク) が案件になることはなく、モデルに渡ることもありません。認証メールがアシスタントから除外される前にそのメールから作られた案件は、email:auth_secrets のない閲覧者には、タイトル、要約、依頼内容、プランの効果を伏せた状態で表示されます。

{
  "type": "today",
  "as_of": "2026-09-02T09:15:00.000Z",
  "projection_lag_ms": 4200,
  "category": null,
  "categories": {
    "partner_inquiry": 1
  },
  "tag": null,
  "tags": {
    "lumenworks": 1
  },
  "sections": {
    "now": [
      {
        "id": "wi_789",
        "version": 3,
        "status": "needs_judgment",
        "title": "Investor update",
        "summary": "Paul needs the August metrics before his 16:00 partner call.",
        "category": "partner_inquiry",
        "tags": [
          "lumenworks"
        ],
        "proposed_tags": [],
        "mailbox": {
          "id": "mbx_123",
          "address": "hello@example.com",
          "name": "Hello"
        },
        "source": {
          "type": "domani-postgres",
          "conversation_id": "conv_1",
          "event_id": "msg_1",
          "revision": 1
        },
        "attention": {
          "level": "now",
          "reason": "Deadline today from a known investor",
          "confidence": "high",
          "deadline": "2026-09-02T16:00:00.000Z"
        },
        "decision": {
          "id": "dec_1",
          "version": 1,
          "status": "open",
          "question": "How do you want to answer Paul?",
          "options": [
            {
              "id": "opt_send",
              "label": "Send current metrics",
              "recommended": true
            },
            {
              "id": "opt_tomorrow",
              "label": "Ask for tomorrow"
            }
          ]
        }
      }
    ],
    "needs_you": [],
    "waiting": [],
    "upcoming": [],
    "handled": []
  }
}

アシスタントの Work 項目と正確な現在のプランを取得

根拠のある Work 項目、その未解決の Decision とオプション、正確な現在の Action プラン、未解決のコミットメントと期待、インタラクション、レシートを返します。assistant:read のアクセス許可が必要です。認証メールがアシスタントから除外される前にそのメールから作られた案件は、email:auth_secrets のない閲覧者には、タイトル、要約、依頼内容、プランの効果を伏せた状態で表示されます。

WorkアイテムのシチュエーションブリーフをRead

エージェントが行動する前に読む1つのドキュメント: シチュエーション(ステータス、アテンション、リカレンス、センダー)、これまでのストーリー(分析済みか否かを問わず、そのすべてのメール)、分析が確立したファクト(バリュー、ベーシス、バリディティを持つクレーム、およびエンティティ)、誰から何をいつから待っているかを含むオープンなコミットメントとエクスペクテーション、すでに解決したもの(クローズされたループと受領)、現在のDecisionとそのオプション、提案される次のステップ(Decisionの推奨オプションがある場合はそれ、ない場合はルール: 期限切れのプロミス、追跡すべき期限切れのエクスペクテーション、センダーのアスクへの回答)、およびエビデンスメッセージ。決定論的で安価: モデルコールなし。エージェントトークンは、操作するメールボックスのアイテムと、渡されたアイテムをRead。

コレスポンデントのシチュエーションブリーフをRead

人に返信する前に知るべきこと: 読み取り可能なメールボックス(または1つのメールボックス)全体での最新のアクティブなWorkアイテムのブリーフ、その人が関係する他のアイテム、および最後の10通のメール。briefは、まだ何も分析されていない場合はnull。

Work アイテムの背後にある事実を読む

アイテムのすべての分析からマージされた主張とエンティティ (最新のものが優先)、さらに保存されたコミットメントと期待とそのステータス。エージェントトークンは、操作するメールボックスのアイテムと、それらに渡されたアイテムを読み取ります。

Work 項目を開封済みにする

所有者がこの Work 項目を現在のバージョンで開いたことを記録し、項目が再び変更されるまで未読マーカーを消します。assistant:write スコープが必要です。

アシスタントがあなたについて学習したこと

同じ送信者または組織が戻ってくるたびに無視された後にアシスタントが提案する静音ルール、有効なミュート（アシスタントが「今日」から外している送信者、ドメイン、状況）とそれぞれの理由、そして一度確認したタグ（それぞれ同じプロジェクトの次の案件に確認なしで適用）。静音ルールは suggestions エンドポイントで受け入れ、ミュートは mutes エンドポイントで、タグは tags エンドポイントで忘れます。

ミュートを忘れる

その送信者、ドメイン、または状況の次のメールが再びアイテムになります。

タグを忘れる

確認なしで適用されるものはなくなります：そのプロジェクトの次の案件は再びタグを提案します。タグを持つ案件はそのまま保持します。

事案を調査する: レジストリとリンクが示すもの

その瞬間に、公開インフラストラクチャが送信者のドメインについて保持している事実(その登録日とレジストラ、そのSPFとDMARC態勢、メールを受信するかどうか)、ソースメッセージのすべてのリンクが実際にどこに向かうか(一度に一ホップずつ辿られるリダイレクト、最終ホストとそのドメインの事実)、および各添付ファイルの実体(名前と宣言された種類に対する最初のバイト列)を読み取ります。これらの事実が追加するシグナル(数日前に登録されたドメイン、別の場所に着地するリンク、何も保護しない送信者のドメイン、ドキュメントとして名付けられたプログラム)とともにドシエを返します。ベンダーなし、アカウントなし、何も保存されません。失敗したルックアップはそれ自体が一つの事実です。

案件の背後にいるのは誰か: 組織、関係者、履歴

案件の送信者カードを返します: 保存されたドメインプロファイルが知る送信者の組織 (名前、法人名、カテゴリ、ウェブサイト、登録日、メールの体制。gmail.com のような共有メールドメインや一度も分析されていないドメインの場合は null で、リアルタイムの分析は決して行いません)、ストーリーのメッセージが from、to、cc に含む人々とその役割、同じ組織に属するかどうか (読者自身のメールボックスは除外)、そして関係: 読者のメールボックス全体でこのアドレスからどれだけのメールが来たか (最大 50 件まで)、最初と最後はいつか、送信者の他の案件、同じドメインの同僚が持ち込んだ案件。assistant:read スコープが必要です。

フェンスされた人間の Decision を記録

オプションを選択、指示を与える、引き継ぐ、スヌーズ、無視、修正、信頼判定を報告(フィッシングまたは正当)、または待機中のプランを承認または却下します(承認されたプランは即座に実行され、その受領書が応答に含まれます)。この呼び出しはwork_item_versionで保護され、idempotency_keyによって冪等に再実行されます。選択または指示は正確な下書きを準備しますが、通常の返信フローを経由します。このエンドポイントはメールを送信しません。assistant:writeスコープが必要です。

不透明 ID による正確なアクションプレビューを取得

準備された Action プランの正確な返信アイデンティティ、受信者、本文、コミットメント、副作用、さらにその有効期限とソースリビジョンを返します。これにより、クライアントはユーザーが assistant_plan_id を使用して既存の返信エンドポイント経由で送信する前に何が起こるかを表示できます。assistant:read スコープが必要です。

コンテンツを最小化したアシスタント Activity を取得

呼び出し元に帰属する最近のインタラクションとレシートをメッセージ本文なしで一覧表示します。assistant:read スコープが必要です。

派生したアシスタントデータをエクスポート

分析、承認されたクレーム、Decision、インタラクション、レシート、モデル使用状況を JSON 添付ファイルとしてエクスポートします。ソースメール本文や添付ファイルのバイトは含まれません。assistant:write スコープが必要です。さらに email:auth_secrets も必要です (それ以外は 403 INSUFFICIENT_SCOPE)。派生状態には、認証メールがアシスタントから除外される前に、アシスタントがそのメールから得た内容が含まれている可能性があります。

アシスタント派生データを削除

派生インテリジェンス、ジョブ、モデル使用状況、デバイス、インポート、設定を冪等的に削除し、元のメールは保持します。assistant:write スコープが必要です。

{
  "ok": true,
  "deleted": {
    "work_items": 12,
    "claims": 40,
    "entities": 9,
    "jobs": 52
  },
  "source_mail_deleted": false
}

秘匿された Now アラート用にデバイスを登録

1つのアプリインストールと環境用の暗号化されたプッシュトークンを登録またはローテーションします。ネイティブアプリのみが呼び出します。アクティブなアシスタントと assistant:write スコープが必要です。

デバイス登録を取り消す

1つのインストールのすべてのプッシュ登録を取り消します（例: サインアウト時）。assistant:write スコープが必要です。

電子メールの DNS 健全性を確認する (MX、SPF、DMARC、DKIM)

ドメインの電子メール DNS 構成 (MX レコード、SPF、DMARC、DKIM) をチェックします。 MX レコード (Google Workspace、Proton、Fastmail) からメール プロバイダーを自動検出します。

{
  "domain": "mysite.com",
  "provider": "google-workspace",
  "mx": {
    "configured": true,
    "records": [
      "1 aspmx.l.google.com",
      "5 alt1.aspmx.l.google.com"
    ]
  },
  "spf": {
    "configured": true,
    "value": "v=spf1 include:_spf.google.com ~all"
  },
  "dmarc": {
    "configured": true,
    "value": "v=DMARC1; p=quarantine; rua=mailto:dmarc@mysite.com"
  },
  "dkim": {
    "configured": true,
    "selectors": [
      "google"
    ]
  }
}

curl https://domani.run/api/domains/mysite.com/email/check \
  -H "Authorization: Bearer domani_sk_xxx"

所有者を対象とした電子メール到達性の健全性を取得する

確定的な認証の準備状況、30 日間の受信者に重み付けされた配信結果、アカウントの安全性の状態、および測定されたプロバイダーの配置を分離します。準備スコアは受信トレイの確率ではなく、測定されていない配置は not_tested として返されます。

curl https://domani.run/api/domains/mysite.com/email/deliverability \
  -H "Authorization: Bearer domani_sk_xxx"

ドメインに電子メールを設定する

ドメイン上で電子メール DNS を事前構成します (オプション)。これは、必要に応じて create_mailbox によって自動的に呼び出されます。既存のメール プロバイダー (Google Workspace、Fastmail、Proton) をオーバーライドするには、force=true を渡します。

ドメインからメールを削除する

ドメインから電子メールを削除し、すべてのメールボックスとメッセージを削除して、emailEnabled を false に設定します。ドメイン全体のメールを変更するため、メールボックスに限定されたトークンには 403 MAILBOX_CONFINED が返されます。

メールのDNSステータスを確認する

ドメインの電子メール DNS 検証ステータスを確認します。ドメインが検証され準備ができているかどうか、DNS レコードの詳細、およびメールボックス数を返します。

domani.run でメールボックスを作成する

domani.run で無料のメール アドレスを作成します (例: hello@domani.run)。ドメインの所有権は必要ありません。無料の @domani.run メールボックスはユーザーごとに 1 つに制限されています。一般的なナメクジの多くは予約されています。

すべてのメールボックスをリストする

ワークスペース許可を含め、代理プリンシパルがすべてのドメインにわたってアクセスできるすべてのメールボックスをリストします。

メールボックスを作成する

メールアドレス（メールボックス）を作成します。 「hello@mysite.com」のような完全なアドレスを入力します。電子メール DNS は、最初の使用時に自動的に構成されます。既存の電子メール プロバイダーをオーバーライドするには、force=true を渡します。カスタム ドメインのメールボックスの容量は、アクティブなアカウントまたはワークスペース プランによって決まります。すべてのアカウントは、POST /api/email を使用して、無料の @domani.run メールボックスを 1 つ個別に作成できます。 workspace_id を渡して、所有するワークスペース内にメールボックスを作成します。カスタム ドメインの場合、これにより、ドメインとそのスコープ外のすべての兄弟メールボックスが明示的かつアトミックにそのワークスペースに導入されます。ドメインを複数のワークスペースに分割することはできません。 kind="hosted" を渡すと、デフォルトの API メールボックス (API + Webhook 経由で送受信) ではなく、実際の IMAP/SMTP メールボックスを独自のドメイン (Apple Mail、Thunderbird、または任意のクライアントに接続) に作成します。ホストされたメールボックスは、公開する DNS レコード、メール クライアント設定、およびワンタイム アプリ パスワードを返します。所有しているドメインが必要です。

すべてのメールボックスをリストする

ワークスペース許可を含め、代理プリンシパルがアクセスできるすべてのメールボックスをリストします。 GET /api/email と同じです。

メールボックスの詳細を取得する

特定のメールボックスの詳細を完全な電子メール アドレス (URL エンコードされたもの、例: hello%40mysite.com) で取得します。

メールボックスを更新する

メールボックスの表示名、Webhook URL、または転送先電子メール アドレスを完全な電子メール アドレスで更新します。無効/クリアするには null に設定します。

メールボックスを削除する

完全な電子メール アドレスを使用してメールボックスを削除します。本体にconfirm=trueが必要です。確認を行わない場合は、message_count を含むプレビューを返します。

メールを送信する

完全なメールアドレスで識別されるメールボックスからメールを送信します。サーバーは最初に必須のバージョン付きポリシーを実行し、客観的な安全上の問題を拒否し、評判や内容品質の問題を警告として返します。共同スレッド返信では、作成リース、確認済みの reply_version、安定した冪等性キーを渡します。サーバーは送信直前に古い返信や二重返信をアトミックに拒否します。1 通あたり最大 20 人、メールボックスあたり 1 時間 100 人までです。

アウトバウンド電子メールのプリフライト

電子メール クォータを送信または消費せずに、送信エンドポイントによって使用される正確なバージョン管理されたサーバー側ポリシーを実行します。サードパーティ ドメイン上のパブリック HTTPS 認証リンクは、レピュテーション警告付きで許可されます。ローカル/プライベート URL、非 HTTPS 認証リンク、および実行可能添付ファイルはブロックされます。 102 KB を超えるボディでは、クリッピング警告が生成されます。

メールの一覧表示

正規のフォルダーまたは仮想ビュー内の電子メールを一覧表示します。デフォルトは受信トレイです。フォルダーの場所は、メッセージの方向やスパム判定とは無関係です。 認証メール (OTP / 検証コード、パスワード リセット、マジック リンク) にはsecurity: "auth"というタグが付けられます。 email:auth_secrets スコープのないトークンには、件名と本文がマスク済み (redacted: true) のメッセージが表示されます。メタデータ (送信者、日付) は表示されたままになります。subject、q、attachments の各フィルターは、呼び出し元が読める内容に対して一致します。このスコープがない場合、そのようなメッセージはマスクされた件名と本文でのみ一致するため、含まれるコードで検索しても何も見つかりません。

意味と単語でメールを検索

読み取り可能なメールボックスを検索します。mailboxで1つのメールボックスに絞ることも可能です。デフォルトではハイブリッド検索：メッセージの埋め込み(pgvector、コサイン類似度)と重み付き単語インデックスを、1つのステートメントで相互ランク融合し、わずかな新着度ブーストを加えます。whyでどちらの分岐がマッチしたかがわかります。qで使えるGmail演算子: from: to: cc: subject: label: filename: mailbox: is:unread|read|starred|unstarred has:attachment in:inbox|archive|sent|spam|trash|anywhere after:2026/08/01 before: newer_than:7d older_than:2w (h/d/w/m/y)、"a phrase"、除外には-wordまたは-from:、a OR b。演算子だけのクエリは、一致するメッセージを新しい順に一覧します(why: filter)。サインインコードやリンク、スパム、システムメールはインデックス化されません。アシスタントのsearch_opt_out_mailbox_idsに含まれるメールボックスは単語検索のみ行われます。agent identityに紐づくトークンは、そのagentが操作するメールボックスのみを検索します。email:readが必要です。email:auth_secrets がない場合、受信した認証メールはランキングの前に除外されます。どの単語、演算子、フィルターにも一致しないため、サインインコードを検索しても何も見つかりません。

curl "https://domani.run/api/emails/search?q=facture+tucows+ao%C3%BBt&limit=5" \
  -H "Authorization: Bearer domani_sk_xxx"

Gmailの受信トレイの接続を開始

あなたのアカウントとインポート境界に紐付けられたGoogleの同意URLを返します。ブラウザで開いてください。同意後、受信トレイは独自のアドレスで接続されたメールボックスになり、境界より後に受信したメール(デフォルト: 過去24時間)がインポートされ、新しいメールは到着と同時に追従します。受信トレイ全体は決してインポートされません: 後でPOST /api/emails/{address}/importで拡大してください。email:writeが必要です。サーバーでGoogle OAuthが設定されている必要があります。

Outlookの受信トレイの接続を開始

あなたのアカウントとインポート境界に紐付けられたMicrosoftの同意URLを返します。ブラウザで開いてください。同意後、受信トレイは独自のアドレスで接続されたメールボックスになり、境界以降に受信したメール(デフォルト: 過去24時間)がインポートされ、新着メールは到着次第追従します。受信トレイ全体は決してインポートされません。後でPOST /api/emails/{address}/importで範囲を広げてください。email:writeが必要です。サーバーでMicrosoft OAuthが設定されている必要があります。

受信トレイを接続できる方法を一覧表示

プロバイダーごとに1行（Gmail、Outlook、転送による任意の受信トレイ、ここでホストされるアドレス）：接続の開始方法（同意画面、転送ルール、作成されたアドレス）、接続ができること（読み取り、または読み取りと書き込み）、古いメールをインポートするかどうか、このサーバーがそれに対して設定されているかどうか。configuredがtrueの場合のみ接続ボタンを表示します。reasonはオペレーターに対して不足している変数を示します。email:readが必要です。

転送により受信箱を接続

受信箱自身のアドレスで接続されたメールボックスを作成し、プラットフォームの転送ドメイン上の転送先アドレスと、Gmail、Outlook、その他のプロバイダーの手順を返します。プロバイダーで転送ルールを追加します。そのアドレスに到着したものは展開され（元の送信者、日付、件名）、接続されたメールボックスの下に保存されます。Gmailは転送先アドレスに確認を求めます：コードとリンクが接続に表示されます。最初に戻ってくるメール、またはプローブ（POST /api/emails/{address}/connector/verify）により、接続がアクティブになります。この方法では新しいメールのみが到着します。古いメールはインポートできません。email:writeが必要です。転送ドメインはサーバーで設定されている必要があります。

転送ルールを通じてプローブを送信

接続された受信箱にメールを送信します。転送ルールがそれを転送先アドレスに戻すと、接続がアクティブになります。転送による接続の場合のみ。email:writeが必要です。

接続されたメールボックスの接続を読み取り

类型、状态、导入边界、同步阶段(导入扫描,然后历史记录)、导入进度(已扫描、已复制、待分析、已分析)、最后同步和最后错误。需要 email:read。転送の確認 (Gmail のコードとリンク) は認証メールです。email:auth_secrets がない場合、その code と url は null になり、redacted: true が付きます。メールボックスに限定されたトークンが見つけられるのは、自身のメールボックスだけです (それ以外は 404)。

接続されたメールボックスを切断

その人自身のコピー(メッセージ、添付ファイル、検索行、保留中のジョブ)と認証情報を削除します。メールボックス行、切断とマークされたリンク、エージェントが行ったこと(受領)は保持されます。接続されたメールボックスのみ切断できます。email:writeが必要です。

接続されたメールボックスの古いメールをインポート

将导入扩大到更早的日期:新的导入运行按到达顺序复制新边界和当前边界之间的邮件,在其自己的成本上限下。在导入扫描仍在运行时拒绝。需要 email:write。

1つのメールボックスを意味と単語で検索

GET /api/emails/searchと同じ検索を、このメールボックスに限定して実行します。email:readが必要です。email:auth_secrets がない場合、受信した認証メールはランキングの前に除外されます。どの単語、演算子、フィルターにも一致しないため、サインインコードを検索しても何も見つかりません。

メールボックスの会話を一覧表示

メールクライアントがグループ化する方法でグループ化されたメッセージ: 返信は応答するメッセージのスレッドに参加します（In-Reply-To、次にReferencesチェーン）、使用可能なヘッダーのないメールは、30日以内に同じ件名と共通の通信相手を持つ最新のスレッドに参加します、それ以外はすべて最初のメッセージのIDをIDとするスレッドを開始します。スレッドは最終アクティビティ順に並べられます。ゴミ箱とスパムは、フォルダとして指定されない限り参加しません。folder=inbox|archive|sentは、そこにメッセージがあるスレッドを保持しますが、会話全体をカウントします。

1つの会話を読み取り、最も古いメッセージから順に表示

スレッドのすべてのメッセージ（ゴミ箱を含む、ストーリーから何も欠けないように）とそのテキスト、最も古いものから順に、参加者と未読数を含みます。認証メールはメッセージ読み取りと同じ方法で編集されます。

メールボックスイベントのストリーム配信（サーバー送信イベント）

text/event-streamを返します。cursorなしの場合、ストリームは現在時点から開始します。since（/api/email/changesのcursorまたは以前のイベントのid）を指定すると、まずその時点以降のすべての変更を再生し、その後メールボックスジャーナルをライブで追跡します。各フレームは、変更のタイプをイベント名（message.received、message.updated、message.deleted、message.moved、message.status、mailbox.resync_required、assistant.item.delegated、assistant.item.recalled、...）として、変更内容を再開可能なcursorを含むJSONデータとして、そして同じcursorをフレームidとして運びます。最初のフレームは再開用のcursorを含むreadyです。キープアライブコメントは20秒ごとに送信されます。接続は約5分後にcloseフレームとretry:ヒントで閉じられます。Last-Event-ID（またはsince）を使用して再接続すると、ギャップや重複なしで再開できます。エージェントトークンは、エージェントが操作するメールボックスに限定されます。認証メールから作られた作業項目に関するエントリーは、email:auth_secrets のないトークンに対して title と ask がマスクされた状態で届きます。

電子メールのフォルダーと数を一覧表示する

システム フォルダーと仮想ビューのサーバー由来の数と、メールボックス バックエンドのライフサイクル機能を返します。

メッセージにライフサイクル アクションを適用する

最大 100 個の明示的なメッセージ ID を移動、復元、既読マーク、スター、または完全に削除します。ゴミ箱への移動は元に戻すことができます。完全に削除するにはemail:deleteが必要で、すでにゴミ箱に入っているメッセージのみを受け入れます。すべての応答は、要求された ID ごとに 1 つの結果を含む永続的な操作の受信です。標準のIdempotency-Keyヘッダーまたは従来のidempotency_keyJSON フィールドに安定したキーを指定し、タイムアウト後にそれを再利用します。正確な再試行では、別の変更を加えずに保存されたレシートが返されます。両方の形式が指定された場合、それらは一致する必要があります。別のリクエストでキーを再利用すると、409 が返されます。省略すると、サーバーはキーを作成し、それを本文と Idempotency-Key ヘッダーで返します。バッチの一部のみが成功した場合は 207 を返します。

メッセージを既読または未読としてマークする

再試行安全な読み取り状態更新のための互換性エンドポイント。正規の永続的なアイテムごとの操作レシートと従来のカウントを返します。タイムアウト後に Idempotency-Key ヘッダーまたは互換性 idempotency_key フィールドを指定して再利用します。

メッセージの一括削除

メッセージを再試行しても安全にゴミ箱に移動する互換性エンドポイント。正規の永続的なアイテムごとの操作レシートと従来のカウントを返します。タイムアウト後に Idempotency-Key ヘッダーまたは互換性 idempotency_key フィールドを指定して再利用します。

メッセージを受け取る

完全な電子メール アドレスで識別されるメールボックスから、ID を使用して 1 つのメッセージを取得します。認証メール (OTP、パスワード リセット、マジック リンク) として分類されたメッセージは、トークンが email:auth_secrets スコープを持っていない限り、件名/本文がマスクされて返されます。

メッセージを削除する

メッセージをゴミ箱に移動します。これはリバーシブルです。 delete_permanently と email:delete トークンを指定したライフサイクル アクションを使用して、すでにゴミ箱に入っているメッセージを消去します。

メッセージに返信する

完全なメールアドレスで識別されるメールボックス内のメッセージに返信します。スレッドヘッダーは自動入力され、quote が false でない限り、メールクライアントと同様に返信の下に元のメッセージが引用されます（アカウントの言語による引用元の行、テキストでは > 行、HTML では gmail_quote ブロック）。共同クライアントは、作成リース、確認済みの reply_version、安定した冪等性キーを渡す必要があります。サーバーは送信直前に古い返信や二重返信をアトミックに拒否します。

メッセージを転送する

完全な電子メール アドレスで識別されるメールボックスから別の受信者にメッセージを転送します。認証メール (OTP、パスワード リセット、マジック リンク) の転送には email:auth_secrets スコープが必要です。これによりシークレットが漏洩されてしまいます。

メールボックスのアバター情報を取得する

Gravatar URL (設定されている場合) と、完全な電子メール アドレスで識別されるメールボックスのサインアップ リンクを返します。

メールボックス Webhook 構成を取得する

Webhook URL、署名シークレット、構成された認証ヘッダー名、およびメールボックスのステータスを返します。ヘッダー値は決して返されません。

メールボックス Webhook を設定する

HMAC 署名付きメールボックス イベントの HTTPS 宛先を構成します。既定では受信メール、さらに (events でオプトインすると) メールボックスから送信したメールの配信結果も届きます。バウンスは送信が受理されてから数秒で送信者に届き、メッセージの履歴にしか残らないということがなくなります。ライブ受信配信は永続的に保存され、すぐに試行され、最大 3 回まで再試行されます。各試行には、1 から始まる X-Domani-Delivery-Attempt が含まれます。オプションの認証または X-API-Key の値は暗号化され、返されません。人間のオペレーターは、CLI 環境変数オプションを使用してモデル コンテキストの外でそれらを送信する必要があります。

curl -X PUT https://domani.run/api/emails/agent%40example.com/webhook \
  -H "Authorization: Bearer domani_sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://agent.example/webhook","events":["email.received","email.bounced","email.delivered"]}'

メールボックス Webhook を削除する

Webhook URL と署名シークレットをメールボックスから削除します。受信メールのみが保存されます。

Webhook 署名シークレットをローテーションする

メールボックス Webhook の HMAC-SHA256 署名シークレットを再生成します。古いシークレットはすぐに無効になります。

メールボックス Webhook のテスト

1 つの署名付きテスト ペイロードをメールボックス Webhook URL に送信します。 HTTP ステータスと配信が成功したかどうかを返します。テストは再試行されません。ライブ受信配信は最大 3 回まで再試行されます。

メールボックスのエイリアスの一覧表示

メールボックスに配信されるすべてのエイリアス アドレスをリストします。エイリアスを使用すると、メールボックス スロットを使用せずに、複数のアドレス (sales@、hello@、contact@) が 1 つの受信トレイを共有できます。

メールボックスのエイリアスを追加する

メールボックス スロットを使用せずに、このメールボックスに配信するエイリアス アドレスを追加します。エイリアスはメールボックスと同じドメイン上にある必要があります。裸のスラッグ (「sales」) または完全なアドレス (「sales@mysite.com」) を入力します。

メールボックスのエイリアスを削除する

メールボックスからエイリアスを削除します。そのアドレスへの電子メールは配信されなくなります。

メールクライアント設定の取得（ホスト型）

ホストされたメールボックスの IMAP/SMTP 接続設定を取得して、Apple Mail、Thunderbird、またはその他のメール クライアントを構成します。ユーザー名は完全なアドレスです。パスワードはアプリのパスワードです (POST /api/emails/{address}/credentials を使用して作成します)。ホスト型メールボックスのみ。

アプリのパスワードをリストする (ホスト型)

ホストされているメールボックスのアプリ パスワードを一覧表示します。シークレットは作成時に 1 回だけ表示されます。これはラベルとメタデータのみを返します。ホスト型メールボックスのみ。

アプリのパスワードを作成する (ホスト型)

メール クライアント (IMAP/SMTP) のパスワードとして使用される、ホストされたメールボックスのアプリ パスワードを作成します。シークレットは一度返されます。今すぐ保存してください。ホスト型メールボックスのみ。

アプリのパスワードを取り消す (ホスト型)

アプリのパスワードを取り消します。これを使用しているメール クライアントはすぐに接続を停止します。ホスト型メールボックスのみ。

メッセージに人間向けのフラグを付ける

メッセージをアカウントの人間にエスカレーションします (または clear=true でフラグをクリアします)。メッセージに needs_human を設定し、その会話をステータス needs_human で保留し、email.escalated Webhook とアプリ内通知を発火します。'answer the easy ones, stop on the one the human must decide' (簡単なものには答え、人間が判断すべきものでは止まる) を支える製品プリミティブです。

フォローアップ リマインダーを設定する

メッセージに 1 回限りのフォローアップ リマインダーを設定します (または clear=true でクリアします)。remind_at の時刻になってもメッセージが未回答の場合 (受信: 返信を送信していない、送信: 相手からの返信を受け取っていない)、email.reminder_due が Webhook とアプリ内通知として発火し、リマインダーは自動的にクリアされます。

連絡先を一覧表示する

メールの往来から自動的に蓄積されるアカウントのアドレス帳: 相手、メッセージ数、最終アクティビティ、メモ。既定では最近アクティブだった順 (order=recent) で、表示向けです。ページ送りのスキャン中に新しいメールを受け取った連絡先はカーソルより前に移動するため、そのスキャンでは取りこぼされることがあります。アドレス帳全体を同期するには order=created を指定してください: 作成日時、次に id の古い順で、この並び順のキーは決して変わらないため、スキャン中ずっと存在する連絡先はちょうど 1 回ずつ返され、その間に作成された連絡先は末尾に来ます。カーソルは発行元と同じ並び順でのみ続行できます (それ以外は 400 INVALID_CURSOR)。すべてのメールボックスのデータを集約するため、メールボックスに限定されたトークンは拒否されます (400 MAILBOX_CONFINED)。

連絡先を作成または更新する

連絡先を保存します: 表示名を設定し、メモ ('prefers short emails'、'decision maker at Acme' など) を添付します。いずれの場合も、メールの往来によってメッセージ数は更新され続けます。

連絡先を削除する

アドレス帳から連絡先を削除します。相手が再びメールを送ってきた場合、メールの往来によって自動連絡先として再作成されます。

受信メールルールをリストする

メールボックスの受信フィルタリング ルールを、適用される優先順位でリストします (最初に一致したものが優先)。

受信メールルールを追加する

フィールド (from/to/subject/body) に一致する受信メッセージに対して実行するルールを追加します。アクション: ドロップ、mark_read、forward (action_arg = アドレス)、webhook_only (forward-to をスキップ)、label (action_arg = ラベル)。ルールは優先順位 (低いものから順) に適用されます。最初に一致したルールが適用されます。

受信メールルールを削除する

メールボックスから受信フィルタリング ルールを削除します。

ドメインキャッチオールを設定する

ドメイン上の一致しないアドレスに送信されたすべての電子メールを、指定されたメールボックスにルーティングします。メールボックス、サブアドレス、またはエイリアスに一致しないものはすべてキャッチオールに入ります。メールボックスはドメイン上にすでに存在している必要があります。ドメイン全体のメールを変更するため、メールボックスに限定されたトークンには 403 MAILBOX_CONFINED が返されます。

ドメインキャッチオールをクリアする

ドメイン上のキャッチオールを削除します。一致しないアドレスへの電子メールは再びドロップされます。ドメイン全体のメールを変更するため、メールボックスに限定されたトークンには 403 MAILBOX_CONFINED が返されます。

1 つのメールボックスを増分同期する

カーソルを使用せずに呼び出して、制限された完全なスナップショットの前にベースラインをキャプチャします。次に、next_cursor を渡して、そのスナップショット中およびその後に発生した変更を再生します。カーソルは不透明で、署名され、メールボックスにバインドされ、30 日後に期限切れになります。プッシュ通知は無効化のヒントにすぎません。このジャーナルは永続的な回復源です。認証メールから作られた作業項目に関するエントリーは、email:auth_secrets のないトークンに対して title と ask がマスクされた状態で届きます。

抑制されたアドレスをリストする

サプレッション リストにアドレスをリストします。ハード バウンスと苦情 (配信イベントから自動的に取り込まれます) に加えて手動エントリを追加します。これらのアドレスへの送信はスキップされます。カーソルでページ分割されます。

抑制を追加する

アドレスを抑制リストに手動で追加して、今後の送信でそのアドレスをスキップします。ハード バウンスと苦情は自動的に追加されます。電子メールの送信を停止したいアドレスにこれを使用します。冪等。

抑制を解除する

サプレッションリストからアドレスを削除すると、再度メールを送信できるようになります (受信者がメールボックスを修正した後など)。

ワークスペースの所有権の譲渡をリクエストする

所有者限定。 48 時間の承認リンクを既存のメンバーに送信します。認証されたメンバーが受け入れるまでは何も動きません。

保留中の所有権移転を取り消す

ワークスペースの所有権を受け入れる

移譲先専用。ワークスペース、対象ドメイン、メールボックスの所有権を一括で移譲します。以前の所有者は管理者となり、既存の支払者は変わりません。

新しいアカウントを作成する

サインインリンクをメールで送信して新しいアカウントの作成（または既存アカウントのサインイン）を開始します。ここではAPIキーは返されません。ブラウザでそのリンクをクリックした人は、すでにサインイン済みの状態でダッシュボードに移動します。ブラウザセッションを持たないCLIやエージェントは、代わりにデバイスログインフロー（POST /api/auth/cli の後に GET /api/auth/cli/poll をポーリング）を使うべきで、同じ承認をメールで送り、承認されるとAPIキーを返します - レスポンスの next_steps にその旨が示されます。ref コードを渡すと、新しいユーザーが紹介者と永続的に結び付けられます - 紹介者はこのユーザーの今後のすべてのドメイン購入についてコミッションを得ます。

{
  "ok": true,
  "verification_required": true,
  "message": "Check your email for a sign-in link to finish creating your account.",
  "hint": "A human must open that email and click the link in a browser to finish verification; no API key is issued yet.",
  "next_steps": [
    "If a person can click the email link, nothing else to do: they land on the dashboard already signed in.",
    "If you are a CLI or agent without a browser session, start a device-login flow instead: POST /api/auth/cli, then poll GET /api/auth/cli/poll?code=... until status is \"complete\" - the same email approves it and hands back an API key, no browser needed on your side."
  ]
}

curl -X POST https://domani.run/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email": "dev@example.com"}'

マジック リンクのサインイン メールを送信する

指定された電子メールにサインイン リンクを送信します。ユーザーが存在しない場合は、最初にアカウントを作成します。マジック リンクは、認証資格情報を使用してダッシュボードにリダイレクトします。プログラムによる API アクセスの場合は、POST /api/auth/register を使用して API キーを直接取得します。

{
  "ok": true,
  "message": "Check your email for a sign-in link."
}

curl -X POST https://domani.run/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "dev@example.com"}'

マジックリンクトークンを検証する

マジック リンク トークンを検証し、認証資格情報を使用してダッシュボードにリダイレクトします。マジック リンク 電子メールによって使用されます。通常、エージェントによって直接呼び出されることはありません。エージェントは代わりに POST /api/auth/register を使用する必要があります。

ホスト間で使うワンタイムのサインインコードを発行する

ブラウザ専用: domani.run または mailzero.run にサインインしている人が、2 通目のマジックリンクなしでもう一方のホストのセッションを再開できるようにします。60 秒間有効で 1 回限り、ホストに紐づいたコードをフラグメントに含む URL を返します。このコードはログに記録されず、クエリ文字列で送信されることもありません。ブラウザセッションの外では役に立たないため、エージェントツールとしては公開されません。

{
  "url": "https://mailzero.run/auth/handoff#code=xxx&next=%2Finbox"
}

ホスト間で使うワンタイムのサインインコードを引き換える

ブラウザ専用: 対象ホストの /auth/handoff ページが呼び出し、URL フラグメントのコードをセッションと交換します。マジックリンクに対する GET /api/auth/verify とまったく同じ動作です。コードは、このリクエストが届いた Host と一致する必要があります。エージェントツールではありません。

{
  "ok": true,
  "next": "/inbox"
}

現在のアカウントの詳細を取得する

電子メール、支払いステータス、連絡先情報ステータス、紹介コード、使用回数など、認証されたユーザーのアカウント情報を返します。エージェントは、購入を試みる前に、認証後にこれを呼び出してhas_payment_methodとhas_contactを確認する必要があります。

{
  "id": "cm5abc123",
  "email": "dev@example.com",
  "plan": "agent",
  "workspace_plans": [
    "mail_pro"
  ],
  "has_payment_method": true,
  "has_contact": true,
  "referral_code": "x7k9m2",
  "referral_rate": 20,
  "domain_count": 3,
  "token_count": 2,
  "created_at": "2025-01-15T10:30:00.000Z"
}

curl https://domani.run/api/me \
  -H "Authorization: Bearer domani_sk_xxx"

アカウント設定を更新する

認証されたユーザーの優先支払い方法および/または BCP 47 ロケールを更新します。 API 応答は構造化されたままであり、翻訳されません。

アカウントの削除 (ドメインが保持されている間はブロックされます)

認証されたユーザーのアカウント、トークン、Webhook、メールボックス、およびその他のアプリケーション データを完全に削除します。登録されたドメインはアカウントとともに削除されません。すべてのドメインが移管されるまで、リクエストは 409 HAS_DOMAINS で失敗します。この操作は元に戻すことができません。

真実のアクティベーション状態と推奨される次のアクションを取得する

サーバー由来の製品マイルストーンと機能を認識した次のアクションを返します。トークンの作成、トークンの使用、ページビュー、クライアントチェックリストの状態は意図的に除外されています。

curl https://domani.run/api/me/activation \
  -H "Authorization: Bearer domani_sk_xxx"

初回実行ガイダンスを閉じるか復元する

プレゼンテーション設定のみを保存します。製品のマイルストーンを完了することはできません。

登録者の連絡先情報を取得する

認証済みユーザーの WHOIS 登録者連絡先情報を返します。購入時は任意です (設定されるまでは、Domani の連絡先がユーザーに代わって新しいドメインを保有します)。ドメインを移管で受け入れる前には必須です。

{
  "has_contact": true,
  "contact": {
    "first_name": "Jane",
    "last_name": "Doe",
    "address1": "123 Main St",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001",
    "country": "US",
    "phone": "+1.2125551234",
    "email": "jane@example.com"
  }
}

curl https://domani.run/api/me/contact \
  -H "Authorization: Bearer domani_sk_xxx"

登録者の連絡先情報を設定する

WHOIS 登録者連絡先情報を設定または更新します。購入時は任意で、ドメインを移管で受け入れる前には必須です。この情報はドメインの登録者および請求先の連絡先になります。設定されるまでは、Domani の連絡先があなたに代わってドメインを保有します。更新すると、連絡先の変更に対応するレジストラにあるすべての有効なドメインに新しい連絡先が送られ、あなたがその登録者になります。レジストラから 15 日以内に確認を求めるメールが届くことがあります。

curl -X PUT https://domani.run/api/me/contact \
  -H "Authorization: Bearer domani_sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"Jane","last_name":"Doe","address1":"123 Main St","city":"New York","state":"NY","postal_code":"10001","country":"US","phone":"+1.2125551234","email":"jane@example.com"}'

連絡先メールアドレスの確認を再送信する

アカウントの連絡先メールアドレスへ確認メールを再送信します。送信はアドレスごとに 15 分に 1 回までです。

サインイン中のデバイスを一覧表示

アカウントにサインインしているすべてのブラウザ、モバイルアプリ、ターミナル。呼び出し元のセッション (current) が先頭です。サインインごとに独自のセッションが開くため、新しいデバイスでサインインしても他のデバイスがサインアウトされることはありません。場所はデバイスがサインインした場所 (IP から推定した国と都市) で、不明な場合は省略されます。API キーはセッションではありません。GET /api/tokens で一覧表示します。

{
  "sessions": [
    {
      "id": "cm5ses123",
      "current": true,
      "kind": "web",
      "product": "domani",
      "device": {
        "type": "desktop",
        "os": "macOS",
        "browser": "Chrome"
      },
      "location": {
        "country": "FR",
        "city": "Paris"
      },
      "signed_in_at": "2026-10-01T10:00:00.000Z",
      "last_active_at": "2026-10-18T09:12:00.000Z"
    },
    {
      "id": "cm5ses456",
      "current": false,
      "kind": "mobile",
      "product": null,
      "device": {
        "type": "mobile",
        "os": "iOS",
        "browser": null
      },
      "location": {
        "country": "FR",
        "city": "Lyon"
      },
      "signed_in_at": "2026-09-20T18:30:00.000Z",
      "last_active_at": "2026-10-17T21:04:00.000Z"
    }
  ],
  "hint": "Sign a device out with DELETE /api/sessions/{id}, or every device but this one with DELETE /api/sessions."
}

curl https://domani.run/api/sessions \
  -H "Authorization: Bearer domani_sk_xxx"

他のすべてのデバイスをサインアウト

リクエストを行っているセッションを除き、アカウントのすべてのセッションをサインアウトします。それらのデバイスは次のリクエストで再度サインインを求められます。API キーは変更されません。

{
  "revoked": 2,
  "hint": "Every other device is signed out. API keys are unchanged."
}

curl -X DELETE https://domani.run/api/sessions \
  -H "Authorization: Bearer domani_sk_xxx"

デバイスをサインアウト

1 つのセッションをサインアウトします。current はリクエストを行っているセッションを指します (自分のサインアウトにスコープは不要)。それ以外のセッションには tokens:write が必要です。

{
  "success": true,
  "current": false,
  "hint": "That device is signed out and will be asked to sign in again."
}

curl -X DELETE https://domani.run/api/sessions/cm5ses456 \
  -H "Authorization: Bearer domani_sk_xxx"

エージェント ID の API トークン一覧を取得

このエージェント ID に紐付けられたトークン（マスクされたキー、スコープ、メールボックスの制限、最終使用日時）。エージェント紐付けトークンは、そのエージェントがすべてのアシスタントとメール画面を見る際のビューです。

1 回の呼び出しでエージェントに専用の API キーを付与

このエージェント ID に紐付けられたトークンを作成します。エージェントが操作するメールボックスに制限され、エージェントが必要とする最小限のスコープ（assistant:read、assistant:write、email:read、email:write）を持ちます。このキーを使用すると、エージェントは自身の Today、自身のメールボックス、および自身に渡されたアイテムのみを読み取ります。別のエージェントを指定すると 403 が返され、オーナー専用ルート（設定、バックフィル、エクスポート）はそれを拒否します。完全なキーはこのレスポンスでのみ返されます。tokens:write が必要です。メールボックスを運用していないエージェントには、既定ではメール系のスコープが付与されず、それを要求すると 400 AGENT_MAILBOXES_REQUIRED が返されます。メールボックスのないキーは、アカウントのすべてのメールボックスに届いてしまうためです。

curl -X POST https://domani.run/api/agents/identity/dave/tokens \
  -H "Authorization: Bearer domani_sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{"name": "Dave on the laptop"}'

エージェントの API トークンを取り消し

このエージェント ID に紐付けられたトークンを取り消します。即座に機能しなくなります。tokens:write が必要です。

API トークンをリストする

認証されたユーザーのすべての API トークンを返します。キーはセキュリティのためにマスクされています (最初の 12 文字と最後の 4 文字が表示されます)。これを使用して、アクティブなトークンを監査します。

{
  "tokens": [
    {
      "id": "cm5abc123",
      "name": "Default",
      "key": "domani_sk_a...wxyz",
      "lastUsed": "2025-02-18T10:30:00.000Z",
      "expiresAt": null,
      "expired": false,
      "scopes": [
        "*"
      ],
      "createdAt": "2025-01-15T10:30:00.000Z",
      "max_per_tx": null,
      "max_per_month": null,
      "spent_this_month": 0,
      "parent_token_id": null,
      "agent_identity": null
    },
    {
      "id": "cm5def456",
      "name": "CI/CD",
      "key": "domani_sk_b...vwxy",
      "lastUsed": null,
      "expiresAt": "2025-05-01T14:00:00.000Z",
      "expired": false,
      "scopes": [
        "domains:read",
        "domains:write"
      ],
      "createdAt": "2025-02-01T14:00:00.000Z"
    }
  ]
}

curl https://domani.run/api/tokens \
  -H "Authorization: Bearer domani_sk_xxx"

新しいAPIトークンを作成する

新しい API トークンを作成します。完全なキーはこの応答でのみ返されます。安全に保管してください。複数のトークンを作成して、さまざまなアプリケーションのアクセスを分離できます。

{
  "id": "cm5ghi789",
  "name": "CI/CD Pipeline",
  "key": "domani_sk_x1Y2z3A4b5C6d7E8f9G0hIjK",
  "expiresAt": "2025-03-20T10:30:00.000Z",
  "scopes": [
    "domains:read",
    "domains:write"
  ],
  "createdAt": "2025-02-18T10:30:00.000Z",
  "max_per_tx": 25,
  "max_per_month": 100,
  "mailbox_ids": [],
  "http_route_policy": null
}

curl -X POST https://domani.run/api/tokens \
  -H "Authorization: Bearer domani_sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{"name": "CI/CD Pipeline"}'

APIトークンを取り消す

API トークンを永久に取り消します。このトークンを使用するアプリケーションはすぐにアクセスできなくなります。この操作は元に戻すことができません。

{
  "success": true
}

curl -X DELETE https://domani.run/api/tokens/cm5abc123 \
  -H "Authorization: Bearer domani_sk_xxx"

セキュリティ監査イベントのリストを表示する

アカウントのセキュリティ監査ログを新しい順に返します。トークンのライフサイクル（作成、失効、権限昇格の試行）、支出上限と max_price による拒否、請求、支払いリクエスト、ブロックされたアカウント削除を含みます。エージェントトークンの動作監視に使用します。

{
  "events": [
    {
      "id": "evt1",
      "tokenId": "cm5abc123",
      "type": "purchase.charged",
      "targetType": "domain",
      "targetId": "mysite.com",
      "metadata": {
        "amountCents": 1450,
        "operation": "buy",
        "method": "card"
      },
      "createdAt": "2026-07-11T10:00:00.000Z"
    },
    {
      "id": "evt2",
      "tokenId": "cm5abc123",
      "type": "purchase.denied_cap",
      "targetType": "domain",
      "targetId": "expensive.ai",
      "metadata": {
        "amountCents": 8470
      },
      "createdAt": "2026-07-11T09:58:00.000Z"
    }
  ],
  "next_cursor": null,
  "hint": "Security-relevant events for this account."
}

curl "https://domani.run/api/audit?limit=50" \
  -H "Authorization: Bearer domani_sk_xxx"

Webhook をリストする

アカウントに構成されているすべての Webhook エンドポイントを一覧表示します。各 Webhook の URL、サブスクライブされたイベント、およびアクティブなステータスを返します。シークレットは作成後に返されることはありません。メールボックスに限定されたトークンには、自身のメールボックスに限定された Webhook だけが表示されます。

{
  "webhooks": [
    {
      "id": "cm5wh001",
      "url": "https://example.com/webhooks/domani",
      "events": [
        "domain.purchased",
        "dns.updated"
      ],
      "active": true,
      "created_at": "2026-02-25T10:00:00.000Z"
    }
  ],
  "hint": "1 webhook(s)."
}

curl https://domani.run/api/webhooks \
  -H "Authorization: Bearer domani_sk_xxx"

Webhook の作成

新しい HTTPS Webhook エンドポイントを登録します。オプションの認証または X-API キーの値は保存時に暗号化され、すべての配信に含まれます。署名シークレットは 1 回だけ返されます。アカウントあたり最大 5 つの Webhook。メールボックスに限定されたトークンが作成した Webhook は同じメールボックスに限定され、ほかのメールボックスのメールイベントは一切受け取りません。

{
  "id": "cm5wh001",
  "url": "https://example.com/webhooks/domani",
  "events": [
    "domain.purchased",
    "dns.updated"
  ],
  "secret": "whsec_aBcDeFgHiJkLmNoPqRsTuVwXyZ012345",
  "active": true,
  "created_at": "2026-02-25T10:00:00.000Z",
  "hint": "Webhook created. Save the secret - it won't be shown again. Use it to verify incoming payloads with HMAC-SHA256."
}

curl -X POST https://domani.run/api/webhooks \
  -H "Authorization: Bearer domani_sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hook","events":["domain.purchased","dns.updated"],"headers":{"Authorization":"Bearer sender_key_xxx"}}'

Webhook を更新する

Webhook の URL、サブスクライブされたイベント、アクティブなステータス、または暗号化された認証ヘッダーを更新します。変更したいフィールドのみを送信してください。メールボックスに限定されたトークンが操作できるのは、自身のメールボックスに限定された Webhook だけです (それ以外は 404)。

Webhook の削除

Webhook エンドポイントを削除します。保留中の配信はすべてキャンセルされます。これを元に戻すことはできません。メールボックスに限定されたトークンが操作できるのは、自身のメールボックスに限定された Webhook だけです (それ以外は 404)。

Webhook 配信の一覧表示

Webhook の最近の配信試行を取得します。イベント タイプ、HTTP ステータス、試行回数、エラーが表示されます。失敗した配信をデバッグするのに役立ちます。メールボックスに限定されたトークンが操作できるのは、自身のメールボックスに限定された Webhook だけです (それ以外は 404)。

{
  "deliveries": [
    {
      "id": "cm5del001",
      "replay_of_id": null,
      "event_type": "domain.purchased",
      "status": "delivered",
      "http_status": 200,
      "attempts": 1,
      "last_error": null,
      "created_at": "2026-02-25T10:05:00.000Z"
    }
  ],
  "hint": "1 delivery(ies) for this webhook."
}

Webhook配信を再生する

不変 Webhook イベントのクローンを作成し、すぐに再配信します。イベント ペイロードとイベント ID は同一のままです。 HMAC 署名は新しいタイムスタンプを受け取ります。必須の冪等性キーにより、呼び出し側が 2 回送信を再試行しないことが保証されます。メールボックスに限定されたトークンが操作できるのは、自身のメールボックスに限定された Webhook だけです (それ以外は 404)。同一のペイロードには例外が一つあります。認証メールからコピーされた件名はマスクされて送信されます。最初の送信以降に Webhook の URL が変わっている可能性があるためです。

Webhook イベント タイプの一覧表示

利用可能なすべての Webhook イベント タイプを説明とともにリストします。認証は必要ありません。

{
  "events": [
    {
      "type": "domain.purchased",
      "description": "A new domain was successfully registered"
    },
    {
      "type": "dns.updated",
      "description": "DNS records were changed for a domain"
    },
    {
      "type": "transfer.completed",
      "description": "A domain transfer completed successfully"
    }
  ]
}

curl https://domani.run/api/webhooks/events

リスト通知

カーソルベースのページネーションでアプリ内通知を一覧表示します。取引イベント、出品の更新、システムアラートが含まれます。 notifications:read スコープが必要です。 メールの件名を書き込み時にマスクするようになる前に書かれた通知は、email:auth_secrets のないトークンに対して、body と data.subject の認証メールの件名がマスクされた状態で読み取られます。

未読通知数を取得する

未読通知数をポーリングするための軽量エンドポイント。 notifications:read スコープが必要です。

{
  "unread_count": 3
}

通知を既読としてマークする

単一の通知を既読としてマークします。 notifications:read スコープが必要です。

すべての通知を既読としてマークする

すべての未読通知を既読としてマークします。 notifications:read スコープが必要です。

通知設定を取得する

カテゴリとチャネル（in_app、email）ごとにユーザーの通知設定を返します。設定がない場合はデフォルトで有効です。 notifications:read スコープが必要です。

通知設定を更新する

特定のカテゴリとチャネルの通知設定を更新します。 notifications:read スコープが必要です。