Codebase Health API

The Health API from Codebase — 1 operation(s) for health.

GitHub OpenAPI

Operations 1

GET /api/v1/health Platform health check #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/codebase-design:codebase-design-health-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

codebase-design-health-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Codebase Design Health API
  version: 1.0.0
  contact:
    email: admin@aipowergrid.io
  description: 'Operations tagged Health across 2 of this provider''s published API definitions: codebase-design-openapi.json, codebase-design-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:3001
  description: Current
- url: https://dev.codebase.design
  description: Development
- url: https://staging.codebase.design
  description: Staging
- url: https://codebase.design
  description: Production
security:
- ApiKeyAuth: []
- BearerAuth: []
tags:
- name: Health
paths:
  /api/v1/health:
    get:
      summary: Platform health check
      description: Returns aggregate health status including Convex, LLM providers, and uptime.
      tags:
      - Health
      security: []
      responses:
        '200':
          description: System healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - healthy
                    - degraded
                    - down
                  checks:
                    type: object
                  uptimeSec:
                    type: integer
                  version:
                    type: string
                  timestamp:
                    type: string
                    format: date-time
        '503':
          description: System unhealthy
      x-codeSamples:
      - lang: TypeScript
        label: TypeScript
        source: "// No authentication required.\n\nconst res = await fetch('https://codebase.design/api/v1/health', {\n  method: 'GET',\n  headers: {\n    'Content-Type': 'application/json',\n  }\n});\n\nif (!res.ok) throw new Error(`${res.status} ${await res.text()}`);\nconst data = await res.json();\nconsole.log(data);"
      - lang: Python
        label: Python
        source: "import os\nimport requests\n\n# No authentication required.\n\nresponse = requests.get(\n    'https://codebase.design/api/v1/health',\n    headers={\n        'Content-Type': 'application/json',\n    }\n)\nresponse.raise_for_status()\nprint(response.json())"
      - lang: Rust
        label: Rust
        source: "// Cargo.toml:\n//   reqwest    = { version = \"0.12\", features = [\"json\"] }\n//   serde_json = \"1\"\n//   tokio      = { version = \"1\", features = [\"full\"] }\n\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), Box<dyn std::error::Error>> {\n    let client = reqwest::Client::new();\n\n    let res = client\n        .get(\"https://codebase.design/api/v1/health\")\n        .header(\"Content-Type\", \"application/json\")\n        .send()\n        .await?;\n\n    let data: serde_json::Value = res.json().await?;\n    println!(\"{:#?}\", data);\n    Ok(())\n}"
      operationId: getApiV1Health
      x-operation-id-source: derived
    servers:
    - url: http://localhost:3001
      description: Current
    - url: http://localhost:3001
      description: Local development
    - url: https://dev.codebase.design
      description: Development
    - url: https://staging.codebase.design
      description: Staging
    - url: https://codebase.design
      description: Production
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Revocable API key (cb_live_... or cb_test_...)
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth2 access token
x-refined-from:
- codebase-design-openapi.json
- codebase-design-openapi.yml