Skip to docs content
Browse and search
On this page

Discover the sandbox stream

The free sandbox stream: its URL, the fixed account list, the operations it sends, its delay and its limits. Connect without a key.

GET/api/agent/sandbox

Response fields

  • accountsobject[]required
    • handlestringrequireda string matching the pattern ^@?[A-Za-z0-9_]{1,15}$
    • idstringrequireda string matching the pattern ^[1-9][0-9]{0,19}$
  • delaySecondsintegerrequiredan integer
  • limitsobjectrequired
    • connectionsPerClientintegerrequiredan integer
    • sessionMinutesintegerrequiredan integer
  • nextobjectrequired
    • messagestringoptionala string at most 500 character(s) long
    • actionenum<string>required
    • whoenum<string>required
  • operationsobject[]required
    • channelenum<string>required
    • openum<string>required
  • statusenum<string>required
  • streamobjectrequired
    • subprotocolenum<string>required
    • urlstringrequireda string matching the pattern ^(https|wss):\/\/[^\s]+$

Responses

  • 200Success
  • 503Temporarily unavailable; retry later