API REFERENCE

Agent Signup

On this page

POST/api/agents/signup

Register an agent. For new agent+ emails, returns an API key immediately. For all other cases, sends a verification code to the email — call POST /api/agents/verify with the code to get your API key.

Tip: If you're unsure what email to register, generate a unique agent+{suffix}@recoupable.com address (e.g. agent+1744410896-28439@recoupable.com, combining a Unix timestamp with a random integer). This guarantees a fresh agent+ address on every call — including multiple signups within the same second — and returns an API key instantly with no email verification required.

Authentication

This endpoint does not require authentication.

Request

cURL

curl --request POST \
  --url 'https://api.recoupable.dev/api/agents/signup' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "agent+mybot@example.com"
}'

Request body required

Agent email to register

application/json

emailstringrequired

The agent email address. Emails with the agent+ prefix (e.g. agent+mybot@example.com) get an API key immediately on first signup.

format: email

Responses

200Signup processed successfully

application/json

account_idstringrequired

The account ID for the registered agent.

format: uuid

api_keystring | null

API key returned immediately for new agent+ prefix emails. Null for all other cases — check your email for a verification code.

messagestringrequired

Human-readable status message.

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download accounts.json

View operation source

json

{
  "description": "Register an agent. For new agent+ emails, returns an API key immediately. For all other cases, sends a verification code to the email — call [POST /api/agents/verify](/api-reference/agents/verify) with the code to get your API key.\n\n**Tip:** If you're unsure what email to register, generate a unique `agent+{suffix}@recoupable.com` address (e.g. `agent+1744410896-28439@recoupable.com`, combining a Unix timestamp with a random integer). This guarantees a fresh `agent+` address on every call — including multiple signups within the same second — and returns an API key instantly with no email verification required.",
  "security": [],
  "requestBody": {
    "description": "Agent email to register",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AgentSignupRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Signup processed successfully",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AgentSignupResponse"
          }
        }
      }
    }
  }
}