API Documentation

Free Public API

Three endpoints need no API key. They are rate limited to 120 requests/minute per IP and built for pipelines and failover rules.

GET /api/healthy/{id}: the pipeline gate

The verdict is the HTTP status code: 200 when every requested service is healthy, 503 otherwise, so curl -f is the entire integration. Gate several services with ?services=claude,openai, and loosen the policy with ?allow=degraded (comma-separated status levels to accept besides operational). Unknown service ids return 404 so a typo fails your pipeline loudly instead of silently passing.

# exits non-zero unless Claude is operational
curl -fsS https://canivibe.ai/api/healthy/claude

# gate on several providers, tolerating degraded performance
curl -fsS "https://canivibe.ai/api/healthy?services=claude,openai&allow=degraded"

The JSON body carries the per-service verdicts:

{
  "healthy": false,
  "checked_at": "2026-07-07T12:00:00Z",
  "services": [
    { "id": "claude", "status": "degraded", "healthy": false,
      "status_since": "2026-07-07T05:41:12Z" },
    { "id": "openai", "status": "operational", "healthy": true }
  ]
}

GET /api/status/{id}: one service

{
  "id": "claude",
  "name": "Claude (Anthropic)",
  "status": "degraded",
  "description": "Claude Code (degraded_performance)",
  "status_since": "2026-07-07T05:41:12Z",
  "last_checked": "2026-07-07T11:59:40Z"
}

GET /api/status: all services

Everything above in one document, plus overall_status. Cached for 30 seconds; CORS enabled (Access-Control-Allow-Origin: *). Status levels are operational, degraded, partial_outage, major_outage, maintenance and unknown.

Authentication

All API requests require authentication using an API key. API keys are available to Pro and Enterprise subscribers. You can create and manage your API keys from the dashboard.

Using Your API Key

Include your API key using one of these two methods:

Authorization Header (recommended):

Authorization: Bearer civ_your_api_key_here

The "Bearer " prefix is required per RFC 6750.

X-API-Key Header:

X-API-Key: civ_your_api_key_here

Rate Limits

Rate limit headers are included in all responses:

• X-RateLimit-Limit - Maximum requests per hour
• X-RateLimit-Remaining - Remaining requests in current window
• X-RateLimit-Reset - Unix timestamp when the limit resets

Endpoints

Base URL: https://canivibe.com/api/v1

Example Response

{
  "providers": [
    {
      "id": "claude",
      "name": "Claude (Anthropic)",
      "status": "operational",
      "last_checked": "2025-01-15T10:30:00Z"
    },
    {
      "id": "openai",
      "name": "OpenAI",
      "status": "operational",
      "last_checked": "2025-01-15T10:30:00Z"
    }
  ]
}

Query Parameters

Example Request

GET /api/v1/status?provider=claude,openai

Example Response

{
  "overall": "operational",
  "providers": [
    {
      "id": "claude",
      "name": "Claude (Anthropic)",
      "status": "operational",
      "description": "All systems operational",
      "last_checked": "2025-01-15T10:30:00Z"
    }
  ],
  "timestamp": "2025-01-15T10:30:00Z"
}

Query Parameters

Example Response

{
  "incidents": [
    {
      "id": "inc_123",
      "provider_id": "claude",
      "provider_name": "Claude (Anthropic)",
      "title": "API Performance Degradation",
      "status": "resolved",
      "impact": "minor",
      "started_at": "2025-01-10T14:00:00Z",
      "resolved_at": "2025-01-10T16:30:00Z"
    }
  ],
  "query": {
    "start": "2024-12-16",
    "end": "2025-01-15",
    "provider": null
  }
}

Query Parameters

Example Response

{
  "history": [
    {
      "provider_id": "claude",
      "provider_name": "Claude (Anthropic)",
      "days": [
        {"date": "2025-01-15", "status": "operational"},
        {"date": "2025-01-14", "status": "degraded"},
        {"date": "2025-01-13", "status": "operational"}
      ]
    }
  ],
  "query": {
    "days": 30,
    "provider": null
  }
}

Error Handling

The API returns standard HTTP status codes and JSON error responses.

Error Response Format

{
  "error": "Unauthorized",
  "code": "invalid_api_key",
  "message": "Invalid or expired API key"
}

Status Codes

Error Codes