Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.auvy.ai/llms.txt

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

SDK errors

Both public SDK packages throw typed errors with stable code fields for branching logic.

Synapse client — AUVYError

import { fromApiKey, AUVYError, ERROR_CODES } from '@auvy-synapse/client'

try {
  await auvy.receptors.get('missing-id')
} catch (e) {
  if (e instanceof AUVYError) {
    if (e.code === ERROR_CODES.NOT_FOUND) { /* … */ }
    if (AUVYError.isRateLimitError(e)) { /* backoff */ }
    if (AUVYError.isRetryableError(e)) { /* retry */ }
  }
}

Common codes

CodeTypical statusMeaning
AUTH_REQUIRED401Missing or expired credential
FORBIDDEN403Valid auth, insufficient access
NOT_FOUND404Resource missing
VALIDATION_ERROR400Bad request body or params
RATE_LIMIT429Throttled — check retry-after
NETWORK_ERROR0Transport failure
TIMEOUT0Request exceeded timeout
trial_expired402/403Workspace trial ended
cost_cap402/403Spend cap reached
The client retries transient failures automatically on idempotent reads; see Integration patterns for production retry guidance.

Connect client — ConnectError

import { connectFromSession, ConnectError, CONNECT_ERROR_CODES } from '@auvy-synapse/connect-client'

try {
  await connect.link(integrationId)
} catch (e) {
  if (e instanceof ConnectError) {
    switch (e.code) {
      case CONNECT_ERROR_CODES.AUTH_REQUIRED:
        // refresh JWT
        break
      case CONNECT_ERROR_CODES.VALIDATION_ERROR:
        // misconfigured factory or bad input
        break
      case CONNECT_ERROR_CODES.UPSTREAM_ERROR:
        // Connect or provider outage
        break
    }
  }
}

Connect codes

CodeMeaning
CONNECT_AUTH_REQUIREDJWT missing or rejected
CONNECT_FORBIDDENUser cannot access integration
CONNECT_NOT_FOUNDIntegration or route missing
CONNECT_VALIDATION_ERRORBad input or factory config
CONNECT_RATE_LIMITThrottled
CONNECT_UPSTREAM_ERRORProvider or Connect 5xx
CONNECT_NETWORK_ERRORTransport failure
connectFromSession() throws CONNECT_VALIDATION_ERROR when baseUrl, publishableKey, or getAccessToken is missing — before any HTTP call.

Server subpath

@auvy-synapse/connect-client/server re-exports ConnectError and CONNECT_ERROR_CODES for S2S execute helpers.