signup

Create a workspace and send an OTP verification email

Creates a new workspace and API key, then sends a 6-digit OTP to the supplied email address. Calling this endpoint again with the same email rotates the API key and re-sends the OTP (idempotent). The rotated key is gated until you re-verify with the new OTP, so knowing an email alone never yields a working key. Call POST /v1/signup/verify with the code to verify.

post/v1/signup

Request

  • Base URL: https://api.framelane.io
  • URL: https://api.framelane.io/v1/signup
  • Auth: none declared

Request body

workspace_namestring required

Display name for the new workspace.

emailstring email required

Email address for the workspace owner. An OTP will be sent here.

api_key_namestring

Label for the first API key.

Example request

{
  "workspace_name": "Acme Corp",
  "email": "dev@acmecorp.com",
  "api_key_name": "default"
}

Response

Successful Response

otp_deliveredboolean

Whether the verification email was actually dispatched. When false, the returned key is inert and cannot be verified — email delivery failed (or is not configured), so retry signup once a working inbox is reachable.

Example response

{
  "workspace": {
    "id": "ws_01J8QR2K5VKDGN2T4FBM3CZYX8",
    "name": "Acme Corp",
    "email": "dev@acmecorp.com"
  },
  "api_key": {
    "id": "key_01J8QR2K5VKDGN2T4FBM3CZYX9",
    "name": "production",
    "key_prefix": "fl_live_k",
    "key": "fl_live_kT9uQw..."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.