Skip to main content
POST
/
v1
/
agents
/
signup
Agent Signup
curl --request POST \
  --url https://api.example.com/v1/agents/signup \
  --header 'Content-Type: application/json' \
  --data '
{
  "terms_accepted": false,
  "agent_name": "<string>",
  "operated_by_email": "<string>",
  "model_metadata": {},
  "altcha": "<string>"
}
'
import requests

url = "https://api.example.com/v1/agents/signup"

payload = {
"terms_accepted": False,
"agent_name": "<string>",
"operated_by_email": "<string>",
"model_metadata": {},
"altcha": "<string>"
}
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({
terms_accepted: false,
agent_name: '<string>',
operated_by_email: '<string>',
model_metadata: {},
altcha: '<string>'
})
};

fetch('https://api.example.com/v1/agents/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.example.com/v1/agents/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([
'terms_accepted' => false,
'agent_name' => '<string>',
'operated_by_email' => '<string>',
'model_metadata' => [

],
'altcha' => '<string>'
]),
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.example.com/v1/agents/signup"

payload := strings.NewReader("{\n \"terms_accepted\": false,\n \"agent_name\": \"<string>\",\n \"operated_by_email\": \"<string>\",\n \"model_metadata\": {},\n \"altcha\": \"<string>\"\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.example.com/v1/agents/signup")
.header("Content-Type", "application/json")
.body("{\n \"terms_accepted\": false,\n \"agent_name\": \"<string>\",\n \"operated_by_email\": \"<string>\",\n \"model_metadata\": {},\n \"altcha\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/agents/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 \"terms_accepted\": false,\n \"agent_name\": \"<string>\",\n \"operated_by_email\": \"<string>\",\n \"model_metadata\": {},\n \"altcha\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "account_id": "<string>",
  "slug": "<string>",
  "email": "<string>",
  "api_key": "<string>",
  "quota": {
    "tier": "<string>",
    "monthly_limit": 123,
    "used": 123,
    "remaining": 123,
    "resets_at": "<string>"
  },
  "endpoints": {},
  "mcp_setup": {},
  "handoff": {},
  "important": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Body

application/json

Body for POST /v1/agents/signup. Every field except terms_accepted is optional.

terms_accepted
boolean
default:false

Must be true. Accepts the Terms at https://superdocs.app/terms. If you are an agent, confirm with your user first.

agent_name
string | null

Optional label for this agent account.

Maximum string length: 64
operated_by_email
string | null

Optional. Your human operator's email (only used if you later hand off the account).

Maximum string length: 255
model_metadata
Model Metadata · object | null

Optional. Free-form metadata about the agent/model (forensics; capped at 10KB).

altcha
string | null

Only required if the proof-of-work challenge is enabled: the base64 solution from GET /v1/agents/challenge.

Response

Successful Response

account_id
string
required
slug
string
required
email
string
required
api_key
string
required

Your API key (sk_...). Shown ONCE. Send it as Authorization: Bearer <key>. Store it now.

quota
AgentQuota · object
required
endpoints
Endpoints · object
required
mcp_setup
Mcp Setup · object
required

Copy-paste commands to connect the SuperDocs MCP server to your client, plus the REST fallback.

handoff
Handoff · object
required
important
string
required