Exceptions¶
Handle TypeSafe API errors, rate limits, connection failures, and timeouts.
export function SdkSignature({children}) { async function copy(event) { const button = event.currentTarget; const code = button.parentElement.querySelector("pre code"); try { await navigator.clipboard.writeText(code.textContent); button.setAttribute("aria-label", "Signature copied"); button.dataset.copied = "true"; } catch { button.setAttribute("aria-label", "Copy failed; select the signature to copy"); } setTimeout(() => { button.setAttribute("aria-label", "Copy signature"); delete button.dataset.copied; }, 2000); } return
{children}
Base exception
typesafe\_sdk.TypeSafeError
Bases: Exception
Base exception for SDK failures.
HTTP errors
typesafe\_sdk.TypeSafeAPIError
Bases: TypeSafeError
An unsuccessful HTTP response with its body and request metadata.
status
instance-attribute
HTTP response status code.
body
instance-attribute
The server's JSON error body, plain response text, or None for an empty body.
headers
instance-attribute
HTTP response headers.
endpoint
instance-attribute
The request method and URL, without credentials, query parameters, or fragment, when available.
request\_id
property
The x-typesafe-request-id response header, or None if absent.
typesafe\_sdk.TypeSafeBadRequestError
Bases: TypeSafeAPIError
The request was invalid (400).
typesafe\_sdk.TypeSafeAuthenticationError
Bases: TypeSafeAPIError
Authentication failed (401).
typesafe\_sdk.TypeSafePermissionDeniedError
Bases: TypeSafeAPIError
Access was denied (403).
typesafe\_sdk.TypeSafeNotFoundError
Bases: TypeSafeAPIError
The resource was not found (404).
typesafe\_sdk.TypeSafeUnprocessableEntityError
Bases: TypeSafeAPIError
The request failed server validation (422).
typesafe\_sdk.TypeSafeRateLimitError
Bases: TypeSafeAPIError
The rate limit was exceeded (429).
retry\_after\_ms
instance-attribute
The server's requested wait in milliseconds, or None if unavailable.
typesafe\_sdk.TypeSafeInternalServerError
Bases: TypeSafeAPIError
The server failed to process the request (5xx).
Connection errors
typesafe\_sdk.TypeSafeAPIConnectionError
Bases: TypeSafeError, ConnectionError
A request failed without an HTTP response.
typesafe\_sdk.TypeSafeAPITimeoutError
Bases: TypeSafeAPIConnectionError, TimeoutError
A request exceeded its configured timeout.
timeout
instance-attribute
The timeout setting used for the request, in seconds or as an httpx2.Timeout.
Response validation
typesafe\_sdk.TypeSafeAPIResponseValidationError
Bases: TypeSafeAPIError
A successful HTTP response whose body was missing or structurally invalid required data.
field\_path
instance-attribute
Dotted path to the offending field, such as answers.tone.confidence.
args
instance-attribute