Skip to main content
POST
/
openclaw
/
signup
cURL
curl --request POST \
  --url https://api.useanima.sh/v1/openclaw/signup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "openclawAgentId": "<string>",
  "organizationName": "<string>",
  "organizationSlug": "<string>",
  "agentName": "<string>",
  "agentSlug": "<string>",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "phoneProvider": "TELNYX",
  "metadata": {}
}
'
{
  "organization": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "agent": {
    "id": "<string>",
    "orgId": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "email": "jsmith@example.com",
    "phoneNumber": "<string>",
    "apiKeyPrefix": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "credentials": {
    "apiKey": "<string>",
    "apiKeyPrefix": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Body

application/json

Input for self-service agent and organization registration via OpenClaw

openclawAgentId
string
required

OpenClaw agent identifier to register

Minimum string length: 1
organizationName
string
required

Display name for the new organization

Required string length: 2 - 120
organizationSlug
string
required

URL-friendly organization slug (lowercase alphanumeric and hyphens)

Required string length: 2 - 64
Pattern: ^[a-z0-9-]+$
agentName
string
required

Display name for the agent

Required string length: 2 - 100
agentSlug
string
required

URL-friendly agent slug (lowercase alphanumeric and hyphens)

Required string length: 2 - 64
Pattern: ^[a-z0-9-]+$
email
string<email>
required

Primary email address for the agent

phoneNumber
string
required

Phone number to provision for the agent

Required string length: 7 - 20
phoneProvider
any
default:TELNYX

Telephony provider for the phone number

metadata
object

Additional metadata for the signup

Response

200 - application/json

OK

Result of a successful self-service signup including organization, agent, and credentials

organization
object
required

Newly created organization details

agent
object
required

Newly created agent details

credentials
object
required

API credentials for the new agent