Skip to main content
POST

Authorizations

Authorization
string
header
required

User JWT access token issued by POST /api/auth/verify or POST /api/auth/social/verify. Routes that accept both auth modes declare api-key and bearer-jwt security schemes.

Headers

x-signature
string

HMAC-SHA256 signature: HMAC-SHA256(secretKey, timestamp + METHOD + path + body). Required for API-key authenticated requests (JWT/OAuth session auth is exempt).

x-timestamp
string

Request timestamp in epoch milliseconds. Required with x-signature for API-key auth. Rejected if drift exceeds 5 minutes.

Body

application/json
agentId
string
required

Internal agent id to follow

tradeMode
enum<string>
Available options:
AUTO_TRADING,
ALERTS_ONLY,
TEST_TRADING,
FULL_TRADING
allocationMode
enum<string>
Available options:
PERCENTAGE_RANGE,
USD_AMOUNT,
SOL_AMOUNT
allocationPercentageMin
number
allocationPercentageMax
number
allocationAmountUsd
number
allocationAmountSol
number
goLiveUponConfirmation
boolean

When true, the agent starts trading immediately after configuration

isPaused
boolean

When true, pause the agent subscription from executing trades

Response

200 - application/json

Subscribe result.

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload