Hello Error • AI Agent SDK

HelloError: Structured connect-rejection envelope.

HelloError

Defined in the protocols module.

Structured connect-rejection envelope.

Emitted from every connection rejection path — both pre-handshake transport checks (auth/origin/rate-limit) and handshake negotiation — so clients can implement deterministic reconnect logic by branching on `(code, next_step)` instead of string-matching close reasons.

Attributes: code: Structured, machine-readable error code. message: Human-readable error message (display only). next_step: Machine-readable recovery hint telling the client what to do next (re-authenticate, re-pair, upgrade, wait then retry, …). retry_after_seconds: Optional backoff hint (rate limiting / transient unavailability). Only meaningful with `WAIT_THEN_RETRY. next_action: Deprecated free-text hint, retained for backward compatibility. Prefer next_step`.

Properties

Source