Browse documentation

Errors

HTTP status codes, quotas, and what to do next

Contract errors return actionable JSON; capacity errors tell you when to upgrade or retry.

Status codes

  • 400 — envelope validation failed, or an optional envelope block that the chosen slug requires is missing. This is a contract error, not an outage.
  • 401 — missing or revoked workspace secret.
  • 410 Gone — unknown or retired /api/v1/<slug>. Body uses error: "unknown_endpoint", a human message, available_endpoints (our 8 core slugs), migration_guide (absolute URL), and note. Responses also include a Warning header. Details: API Simplification – April 2026.
  • 429 — monthly workspace pool exhausted on the free plan. Paid Builder and Production meter overages instead of returning 429 for included+overage traffic — see quotas below.
  • 503 — host is mid-deploy or not fully wired for paid traffic. Retry with backoff. If it continues, contact support@cashytics.com or the team that manages your Cashytics deployment.

Quotas & overage philosophy

Free workspaces ship with 500 successful /api/v1/* POSTs per UTC month. Builder includes 5,000 successful calls per month with overage at $6 / 1,000 calls. Production includes 25,000 with overage at $4 / 1,000 calls. On paid tiers, traffic is metered rather than hard-stopped at the included cap so live workflows keep running.

Uptime monitoring with GET /api/health

GET /api/healthreturns a small JSON payload suitable for synthetic checks. Point external uptime services (Uptime Robot, Better Uptime, Datadog synthetics, etc.) at your deployment's absolute URL (for example https://cashytics.com/api/health when hosted on the public site) to prove availability to your own ops team or to prospects evaluating reliability.

The deployment_ready field signals whether billing, auth, and metering wiring are healthy for this host — useful after deploys.