API Reference
API Reference / Endpoints / Platform

Health check

/v1/health

Check whether the public v1 API is reachable.

GET/v1/health
Auth: PublicBilling: FreeBehavior: Sync
GETSyncNo body

When to use it

Use this for availability checks, smoke tests, and simple connectivity validation before you send authenticated traffic.

Behavior on success

Returns a completed payload on the normal success path.

Integration shape

Authorization model
Public route
Request format
No request body
Polling pattern
No polling required on the normal success path.

Example request

GET /v1/health
const response = await fetch('https://prod-backup-backend.wubble.ai/v1/health', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.WUBBLE_API_KEY}`,
  },
});

const payload = await response.json();
console.log(payload);

Example response

Response shapejson
{
  "success": true,
  "data": {
    "status": "ok",
    "version": "v1",
    "timestamp": "2026-05-12T12:00:00.000Z"
  }
}

Implementation notes

Public route. No API key or dashboard session is required.

Production guidance

Pair this route with idempotency on POST requests and either request polling or webhooks whenever the response is asynchronous.
Was this page helpful?