PermitPlane Docs

Let your AI assistant create your account

An AI assistant without a PermitPlane account can start one for you. You stay in control: nothing is created until you confirm by email, with two-factor authentication, the terms and a code.

What happens

  1. The assistant calls POST /manage/v1/signups (tool start_signup) with your email address and a workspace name. It gets a user_code and a poll_token and shows you the code.
  2. You receive one email from PermitPlane with a link. The email contains fixed text only: nothing the assistant wrote.
  3. You open the link, sign in or create a password, verify your email and set up two-factor authentication.
  4. On the confirm page you type the code the assistant showed you, accept the terms and press Confirm. Pressing Decline stops the request.
  5. The assistant calls get_signup_status (GET /manage/v1/signups/{signup_id} with Authorization: Signup <poll_token>) every poll_interval_seconds. The first completed answer contains a sandbox API key, once.

Agent signup creates new workspaces only, on the free plan. There is no service trial; the trial in PermitPlane (14 days by default, 1 to 90 per policy) is the trial licence your own customers get. If the person who confirms already has a workspace, nothing is created: the status becomes has_workspace with a hint, and they create an Agent setup key themselves in the console under API keys. The answer to step 1 is the same for new and existing addresses.

Statuses

statusmeaningassistant should
awaiting_humanwaiting for youkeep polling
completedyou confirmed; api_key is present in the first answer onlystore the key where you say; never paste it into chat
declinedyou pressed Declinestop
has_workspacethe confirming person already has a workspace; no key existsshow the hint to the human
expired24 hours without confirmation or collection, or 5 wrong codesstart again

The key

Sandbox only, all your sandbox products, 30 days, revocable in the console. It can create further API keys and export audit logs, and it can request go-live (you approve in the console). The confirm page lists every action. Revoking the key also revokes the keys it created. It can never approve changes, manage the team, pay or delete the workspace: those need you, signed in with two-factor authentication. If the key is lost, revoke it and start again.

Limits

5 starts per client IP per hour (429 with Retry-After). An address receives at most 3 emails per day; further requests look the same but send no email. Code entry is limited to 5 attempts.

Terms

The terms are accepted by a human, never by a key. Owners who created their workspace before agent signup accept the current version at /console/terms/; this is needed before a product goes live.

Billing

With the key, the assistant can read the plan (get_billing) and get a console link for payment (create_checkout_link, create_billing_portal_link). You open the link, sign in with two-factor authentication and pay there. The assistant never sees payment details.

Self-hosted

Agent signup is off by default. Set AGENT_SIGNUP_ENABLED=1 and VENDOR_SELF_SERVICE_ENABLED=1; both are required. While off, the endpoints answer 404.