Create Monitor Session

Buy a time window on WS /monitor, priced per hour. The token works for any number of connections until expires_at: send it as Authorization: Bearer <token> or ?access_token=<token>. Partners receive a token at no charge. Send X-Partner-Name and X-Partner-API-Key, or pay with x402: without partner headers the route answers 402 with a PAYMENT-REQUIRED header; retry with PAYMENT-SIGNATURE. Payment settles only on a 2xx and the receipt is returned in PAYMENT-RESPONSE.

POST /api/v1/monitor/sessions

Create Monitor Session

cURL

curl --request POST \
  --url https://si.ampli.net/api/v1/monitor/sessions \
  --header 'Content-Type: application/json' \
  --header 'X-Partner-API-Key: <api-key>' \
  --header 'X-Partner-Name: <api-key>' \
  --data '{
  "hours": 2
}'

200

{
  "token": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "session_id": "<string>",
  "subject": "<string>",
  "hours": 123,
  "websocket_url": "<string>",
  "subscribe_message": {},
  "payer": "<string>"
}

Authorizations

X-Partner-Name · string · header · required

X-Partner-API-Key · string · header · required

Headers

X-Partner-API-Key · string | null

X-Partner-Name · string | null

PAYMENT-SIGNATURE · string | null

Body

application/json

hours · integer · required

Length of the session window in hours

Required range: x >= 1

Response

200

application/json

Successful Response

token · string · required

expires_at · string<date-time> · required

session_id · string · required

subject · string · required

hours · integer · required

websocket_url · string · required

subscribe_message · Subscribe Message · object · required

Example first message to send after connecting

payer · string | null

Paying wallet for x402 sessions; null for partners