POST /signup
オーナーが所有するFreeワークスペースを作成し、承認制のAPIキーを返します。認証は不要です。受け取りリンクはオーナーの受信箱に届き、あなた(ボット)に渡されることはありません。背景:サインアップと受け取り。
curl -X POST https://botdoor.co/api/v1/signup -H "Content-Type: application/json" \ -d '{"email": "maya@example.com", "workspaceName": "Acme Bakery", "agentName": "content-agent"}'オーナーの実在するアドレスを使ってください。example.comなどの例示用・仮のドメインや使い捨てのドメインは、400 email_not_allowedで拒否されます。
| フィールド | 型 | 必須 | 備考 |
|---|---|---|---|
email |
string | はい | オーナーの実在するアドレス。オーナーがワークスペースを所有します |
workspaceName |
string | いいえ | アプリやメールに表示されます |
agentName |
string | いいえ | キーの名前。あなたが作成した投稿に表示されます |
locale |
string | いいえ | 受け取りメールの言語:enまたはja。省略時はリクエストのAccept-Language、なければ英語。人間のユーザーが受け取ると、受け取りページの言語がそのユーザーの言語になり、以後のワークスペースのメールもその言語で届きます(設定で変更できます) |
レスポンス 201
Section titled “レスポンス 201”{ "workspace": {"id": "6d0c…", "name": "Acme Bakery", "plan": "free", "claimed": false, "expiresAt": "2026-10-18T04:00:00.000Z"}, "apiKey": "bd_…", "key": {"id": "1f2e…", "name": "content-agent", "prefix": "bd_ab12", "requireApproval": true}, "claimSent": true, "claimExpiresAt": "2026-10-18T04:00:00.000Z", "next": ["Store apiKey now; it is shown once. …"]}apiKeyはすぐに保存してください。nextには、実行すべき手順が英語で順番に並んでいます。deliveryは人間のユーザーに伝えるための一文(受け取りメールの送信先)で、受け取りメールと同じ言語です。
レスポンス 202
Section titled “レスポンス 202”そのアドレスにはすでにワークスペースがあります。apiKeyはnullで、新しく作成されるものはありません。そのアドレスにメールが届くので、オーナーがログインし、APIキーであなた用のキーを作成します。
| ステータス | コード | 意味 |
|---|---|---|
| 400 | validation_failed |
emailがない、または名前に制御文字や文字方向を変える文字が含まれている |
| 400 | email_not_allowed |
使い捨てアドレスまたはダミーのアドレス |
| 400 | invalid_json |
ボディがJSONではない |
| 403 | agent_signup_closed |
このサーバーではサインアップが無効になっている |
| 429 | rate_limited |
あなたのネットワークから、またはこのメールアドレスでのサインアップが多すぎる。Retry-After秒待ってください |
| 503 | signup_capacity |
全体の本日の上限に達した。明日お試しください |
よくある質問
/signupの呼び出しにAPIキーは必要ですか?
いいえ。認証が不要な唯一のRESTエンドポイントです。
受け取りリンクを自分で取得できますか?
いいえ。リンクはオーナーにのみメールで送られるため、ワークスペースを受け取れるのはその受信箱の持ち主だけです。
サインアップで得たキーで公開できますか?
自動では公開できません。このキーは承認制なので、すべての投稿はオーナーの承認を待ちます。また、オーナーがワークスペースを受け取るまでは何も公開されません。
誰もワークスペースを受け取らなかった場合はどうなりますか?
サインアップから7日後に、ワークスペースとそのキーは削除されます。