curl --request POST \
--url https://api.framelane.io/v1/signup \
--header 'Content-Type: application/json' \
--data '
{
"workspace_name": "Acme Corp",
"email": "dev@acmecorp.com",
"api_key_name": "default"
}
'import requests
url = "https://api.framelane.io/v1/signup"
payload = {
"workspace_name": "Acme Corp",
"email": "dev@acmecorp.com",
"api_key_name": "default"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
workspace_name: 'Acme Corp',
email: 'dev@acmecorp.com',
api_key_name: 'default'
})
};
fetch('https://api.framelane.io/v1/signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.framelane.io/v1/signup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workspace_name' => 'Acme Corp',
'email' => 'dev@acmecorp.com',
'api_key_name' => 'default'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.framelane.io/v1/signup"
payload := strings.NewReader("{\n \"workspace_name\": \"Acme Corp\",\n \"email\": \"dev@acmecorp.com\",\n \"api_key_name\": \"default\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.framelane.io/v1/signup")
.header("Content-Type", "application/json")
.body("{\n \"workspace_name\": \"Acme Corp\",\n \"email\": \"dev@acmecorp.com\",\n \"api_key_name\": \"default\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.framelane.io/v1/signup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspace_name\": \"Acme Corp\",\n \"email\": \"dev@acmecorp.com\",\n \"api_key_name\": \"default\"\n}"
response = http.request(request)
puts response.read_body{
"workspace": {
"id": "ws_01J8QR2K5VKDGN2T4FBM3CZYX8",
"name": "Acme Corp",
"created_at": "2023-11-07T05:31:56Z",
"email": "dev@acmecorp.com",
"email_verified": false,
"plan": "free",
"plan_status": "active"
},
"api_key": {
"id": "key_01J8QR2K5VKDGN2T4FBM3CZYX9",
"name": "production",
"key_prefix": "fl_live_k",
"created_at": "2023-11-07T05:31:56Z",
"key": "fl_live_kT9uQw...",
"last_used_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z"
},
"otp_delivered": true
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}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.
curl --request POST \
--url https://api.framelane.io/v1/signup \
--header 'Content-Type: application/json' \
--data '
{
"workspace_name": "Acme Corp",
"email": "dev@acmecorp.com",
"api_key_name": "default"
}
'import requests
url = "https://api.framelane.io/v1/signup"
payload = {
"workspace_name": "Acme Corp",
"email": "dev@acmecorp.com",
"api_key_name": "default"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
workspace_name: 'Acme Corp',
email: 'dev@acmecorp.com',
api_key_name: 'default'
})
};
fetch('https://api.framelane.io/v1/signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.framelane.io/v1/signup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workspace_name' => 'Acme Corp',
'email' => 'dev@acmecorp.com',
'api_key_name' => 'default'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.framelane.io/v1/signup"
payload := strings.NewReader("{\n \"workspace_name\": \"Acme Corp\",\n \"email\": \"dev@acmecorp.com\",\n \"api_key_name\": \"default\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.framelane.io/v1/signup")
.header("Content-Type", "application/json")
.body("{\n \"workspace_name\": \"Acme Corp\",\n \"email\": \"dev@acmecorp.com\",\n \"api_key_name\": \"default\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.framelane.io/v1/signup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspace_name\": \"Acme Corp\",\n \"email\": \"dev@acmecorp.com\",\n \"api_key_name\": \"default\"\n}"
response = http.request(request)
puts response.read_body{
"workspace": {
"id": "ws_01J8QR2K5VKDGN2T4FBM3CZYX8",
"name": "Acme Corp",
"created_at": "2023-11-07T05:31:56Z",
"email": "dev@acmecorp.com",
"email_verified": false,
"plan": "free",
"plan_status": "active"
},
"api_key": {
"id": "key_01J8QR2K5VKDGN2T4FBM3CZYX9",
"name": "production",
"key_prefix": "fl_live_k",
"created_at": "2023-11-07T05:31:56Z",
"key": "fl_live_kT9uQw...",
"last_used_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z"
},
"otp_delivered": true
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}Body
Display name for the new workspace.
1 - 255"Acme Corp"
Email address for the workspace owner. An OTP will be sent here.
320"dev@acmecorp.com"
Label for the first API key.
1 - 255"default"
Response
Successful Response
Show child attributes
Show child attributes
Returned once at creation time -- includes the plaintext secret.
Show child attributes
Show child attributes
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.

