curl --request POST \
--url https://api.useanima.sh/v1/agent/sign-up \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"human_email": "jsmith@example.com",
"username": "<string>",
"name": "<string>",
"provision_vault": true,
"source": "unknown"
}
'import requests
url = "https://api.useanima.sh/v1/agent/sign-up"
payload = {
"human_email": "jsmith@example.com",
"username": "<string>",
"name": "<string>",
"provision_vault": True,
"source": "unknown"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
human_email: 'jsmith@example.com',
username: '<string>',
name: '<string>',
provision_vault: true,
source: 'unknown'
})
};
fetch('https://api.useanima.sh/v1/agent/sign-up', 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.useanima.sh/v1/agent/sign-up",
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([
'human_email' => 'jsmith@example.com',
'username' => '<string>',
'name' => '<string>',
'provision_vault' => true,
'source' => 'unknown'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.useanima.sh/v1/agent/sign-up"
payload := strings.NewReader("{\n \"human_email\": \"jsmith@example.com\",\n \"username\": \"<string>\",\n \"name\": \"<string>\",\n \"provision_vault\": true,\n \"source\": \"unknown\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.useanima.sh/v1/agent/sign-up")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"human_email\": \"jsmith@example.com\",\n \"username\": \"<string>\",\n \"name\": \"<string>\",\n \"provision_vault\": true,\n \"source\": \"unknown\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/agent/sign-up")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"human_email\": \"jsmith@example.com\",\n \"username\": \"<string>\",\n \"name\": \"<string>\",\n \"provision_vault\": true,\n \"source\": \"unknown\"\n}"
response = http.request(request)
puts response.read_body{
"agent_id": "<string>",
"organization_id": "<string>",
"inbox_id": "<string>",
"api_key": "<string>",
"auth_type": "agent_unverified",
"vault_id": "<string>"
}Post agentsign up
curl --request POST \
--url https://api.useanima.sh/v1/agent/sign-up \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"human_email": "jsmith@example.com",
"username": "<string>",
"name": "<string>",
"provision_vault": true,
"source": "unknown"
}
'import requests
url = "https://api.useanima.sh/v1/agent/sign-up"
payload = {
"human_email": "jsmith@example.com",
"username": "<string>",
"name": "<string>",
"provision_vault": True,
"source": "unknown"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
human_email: 'jsmith@example.com',
username: '<string>',
name: '<string>',
provision_vault: true,
source: 'unknown'
})
};
fetch('https://api.useanima.sh/v1/agent/sign-up', 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.useanima.sh/v1/agent/sign-up",
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([
'human_email' => 'jsmith@example.com',
'username' => '<string>',
'name' => '<string>',
'provision_vault' => true,
'source' => 'unknown'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.useanima.sh/v1/agent/sign-up"
payload := strings.NewReader("{\n \"human_email\": \"jsmith@example.com\",\n \"username\": \"<string>\",\n \"name\": \"<string>\",\n \"provision_vault\": true,\n \"source\": \"unknown\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.useanima.sh/v1/agent/sign-up")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"human_email\": \"jsmith@example.com\",\n \"username\": \"<string>\",\n \"name\": \"<string>\",\n \"provision_vault\": true,\n \"source\": \"unknown\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/agent/sign-up")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"human_email\": \"jsmith@example.com\",\n \"username\": \"<string>\",\n \"name\": \"<string>\",\n \"provision_vault\": true,\n \"source\": \"unknown\"\n}"
response = http.request(request)
puts response.read_body{
"agent_id": "<string>",
"organization_id": "<string>",
"inbox_id": "<string>",
"api_key": "<string>",
"auth_type": "agent_unverified",
"vault_id": "<string>"
}Authorizations
JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer
Body
Self-service agent sign-up — no human required
Your human's email address — used for verification and claiming
Preferred inbox username (e.g. 'my-agent' → 'my-agent@agents.useanima.sh')
2 - 64^[a-z0-9-]+$Display name for the agent. Defaults to username if omitted
2 - 100Provision an encrypted vault for the new agent as part of sign-up. This is the only way a self-service agent can obtain a first vault: vault.provision is master-gated, and sign-up never discloses the master key. Safe here precisely because the org is being created by this same call — there is no existing privilege to escalate from.
Channel that produced this sign-up (e.g. 'smithery'). Optional; defaults to 'unknown'. Unrecognised values coerce rather than fail.
smithery, cline, dxt, open-mcp, cli, skill-md, web, unknown Response
OK
Sign-up response with credentials
Your agent ID
Your organization ID
Your email address (e.g. 'my-agent@agents.useanima.sh')
Your API key — save this immediately, it won't be shown again
Current verification status
agent_unverified, agent_verified, claimed Vault identity id when provision_vault was requested and granted, else null. Null with provision_vault=true means the vault feature is off on this deployment — sign-up still succeeded.
