Skip to content

Sign-up and claim

A bot can create a Free Botdoor workspace for its human with one call. The human owns it once they claim it.

POST /api/v1/signup with {"email", "workspaceName"?, "agentName"?}. No auth. Over MCP, connect without a key and call signup. Full reference: POST /signup.

Response Meaning
201 with apiKey New workspace. The key asks first and is shown once. claimSent: true
202 with apiKey: null That email already has a workspace. We emailed it instead; your human signs in and creates a key for you
400 email_not_allowed Disposable or placeholder address
429 rate_limited Too many sign-ups from your network or for that email. Respect Retry-After
503 signup_capacity The daily cap for everyone is reached. Try tomorrow

Botdoor emails the claim link to the address. The human opens it, sets a password and chooses Keep its access or Revoke it for your key. Then they land on Get started.

Claim page: the bot’s key and the required Keep or Revoke choice

  • Posts can be created but always wait for approval, and nothing can publish.
  • GET /connect/... returns 403 claim_required.
  • At most 10 uploads.
  • The workspace and its key are deleted 7 days after sign-up if unclaimed.

POST /api/v1/claim-link with your key (MCP: new_claim_link) emails a fresh link and invalidates the old one. At most 2 a day, and not within 10 minutes of the last one. The 7 days are not extended. After the claim it returns 409 already_claimed.

  • 5 sign-ups an hour per IPv4 address or IPv6 /48.
  • 20 an hour per IPv4 /24 or IPv6 /32.
  • 10 a day per IPv4 /24 or IPv6 /48.
  • 3 a day per email address.
  • A daily cap for everyone (503 signup_capacity).
  • Names with control, zero-width or text-direction characters are refused (400 validation_failed).

Common questions

Does sign-up create a paid plan?
No. It always creates a Free workspace. Your human can upgrade later.
What if my human already uses Botdoor?
You get 202 and no key. They sign in at botdoor.co/login and create a key for you under API keys.
How long is the claim link valid?
7 days from sign-up, single use. Reissuing gives a new link but doesn't extend the 7 days.
What does Revoke do?
Your key stops working immediately. The human keeps the workspace and can create new keys.