Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nexalayer.net/llms.txt

Use this file to discover all available pages before exploring further.

​
Telemetry overview

Telemetry lets agents report proxy usage outcomes (success, errors, captcha, timeout, block). The system updates session health and can return a recommendation (e.g. consider_rotate, rotate_now). Strongly recommended for all agents.

​
Event types

event_typeDescription
successRequest succeeded
http_errorHTTP error (use status_code, e.g. 403, 429)
captchaCaptcha encountered
timeoutConnection/request timeout
blockIP blocked
rate_limitTarget rate-limited
customCustom event

​
Single event: report-event

curl -X POST "https://api.nexalayer.net/v1/sessions/sess_xxx/report-event" \
  -H "X-API-Key: <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type": "success",
    "status_code": 200,
    "latency_ms": 320,
    "target_host": "example.com"
  }'
recommendation: ok | consider_rotate | rotate_now | pause. Use it to decide when to call Rotate. Next: Session health, Batch report.