codai Health API

Cloud Run liveness / readiness probes.

GitHub OpenAPI

Operations 3

2 of 3 operations are conformant: apis.io called them with no credentials and the responses matched this contract. Checked 2026-11-12. how this works · status file

GET /health Liveness probe conformant #
GET /health/ready Readiness probe (database) conformant #
GET /status Catalog and provider status #

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/codai-ro:codai-ro-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

codai-ro-health-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Codai Ro Health API
  version: '1'
  description: 'Operations tagged Health across 6 of this provider''s published API definitions: codai-ro-auth-openapi.json, codai-ro-gateway-openapi.json, codai-ro-resolve-openapi.json, codai-ro-auth-openapi.yml, codai-ro-gateway-openapi.yml, codai-ro-resolve-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://auth.codai.ro
  description: Production
- url: https://ai.codai.ro
  description: Production
- url: https://resolve.codai.ro
  description: Production (private beta)
tags:
- name: Health
  description: Cloud Run liveness / readiness probes.
paths:
  /health:
    get:
      operationId: authHealth
      tags:
      - Health
      summary: Liveness probe
      description: 'Returns `{ ok: true }` when the process is up. No dependencies are checked.'
      responses:
        '200':
          description: Process is up.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                properties:
                  ok:
                    type: boolean
                    const: true
    servers:
    - url: https://auth.codai.ro
      description: Production
  /health/ready:
    get:
      operationId: authReady
      tags:
      - Health
      summary: Readiness probe (database)
      description: Runs `select 1` against the database. `503` with the error text when the database is unreachable.
      responses:
        '200':
          description: Database reachable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadyResponse'
        '503':
          description: Database check failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadyResponse'
    servers:
    - url: https://auth.codai.ro
      description: Production
  /status:
    get:
      operationId: getStatus
      tags:
      - Health
      summary: Catalog and provider status
      security: []
      description: 'Lists every alias in the live registry (including hidden internal ones) and every provider adapter with its

        last known health (`healthy: false` only when a probe explicitly marked it down). Unauthenticated and not under

        `/v1`; `ok` is always `true` — use `/health/ready` for a pass/fail signal.'
      responses:
        '200':
          description: Registry snapshot.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoreStatus'
    servers:
    - url: https://ai.codai.ro
      description: Production
components:
  schemas:
    ReadyResponse:
      type: object
      title: Readiness response
      required:
      - ok
      - checks
      properties:
        ok:
          type: boolean
        checks:
          type: object
          required:
          - db
          properties:
            db:
              type: object
              required:
              - ok
              properties:
                ok:
                  type: boolean
                error:
                  type: string
    CoreStatus:
      type: object
      title: Status
      required:
      - ok
      - aliases
      - providers
      properties:
        ok:
          type: boolean
          enum:
          - true
        aliases:
          type: array
          description: Every alias id in the live registry, including hidden internal ones.
          items:
            type: string
          examples:
          - - codai
            - codai-fast
            - codai-embed
        providers:
          type: array
          items:
            $ref: '#/components/schemas/CoreStatusProvider'
    CoreHealthCheck:
      type: object
      title: Readiness check
      required:
      - ok
      properties:
        ok:
          type: boolean
        error:
          type: string
          description: Present only when `ok` is false; the stringified failure.
    CoreStatusProvider:
      type: object
      title: Provider status
      required:
      - id
      - kind
      - label
      - healthy
      properties:
        id:
          type: string
          description: Provider row id.
        kind:
          type: string
          description: Adapter kind (e.g. `vertex-anthropic`, `azure-openai`, `voyage-embeddings`).
        label:
          type: string
        healthy:
          type: boolean
          description: False only when a probe explicitly marked the adapter down; unknown counts as healthy.
    CoreHealthReady:
      type: object
      title: Readiness
      required:
      - ok
      - checks
      - s1
      properties:
        ok:
          type: boolean
          description: True only when every entry in `checks` passed.
        checks:
          type: object
          required:
          - db
          - schema
          - registry
          properties:
            db:
              allOf:
              - $ref: '#/components/schemas/CoreHealthCheck'
              description: '`select 1` against Postgres.'
            schema:
              allOf:
              - $ref: '#/components/schemas/CoreHealthCheck'
              description: The auth-path `api_keys` select — fails when the image's schema is ahead of the database.
            registry:
              allOf:
              - $ref: '#/components/schemas/CoreHealthCheck'
              description: At least one provider adapter is loaded.
        s1:
          type: object
          description: Informational reachability of the codai-s1 sidecar; never affects `ok`.
          required:
          - mode
          properties:
            mode:
              type: string
              enum:
              - 'off'
              - shadow
              - 'on'
            ok:
              type: boolean
              description: Absent when `mode` is `off` or no base URL is configured.
            ms:
              type: integer
              description: Round-trip time of the probe in milliseconds.
            error:
              type: string
              description: '`HTTP <status>` or the stringified fetch error.'
    CoreHealth:
      type: object
      title: Liveness
      required:
      - ok
      - features
      properties:
        ok:
          type: boolean
          enum:
          - true
        features:
          type: array
          description: Append-only capability flags of the running image.
          items:
            type: string
          examples:
          - - frontier-tier
    ResolveHealth:
      type: object
      required:
      - ok
      - service
      properties:
        ok:
          type: boolean
          const: true
        service:
          type: string
          const: codai-resolve
  securitySchemes:
    oauth2:
      type: oauth2
      description: codai OpenID Connect provider. PKCE `S256` required on the authorization code flow.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.codai.ro/auth
          tokenUrl: https://auth.codai.ro/token
          refreshUrl: https://auth.codai.ro/token
          scopes:
            openid: Verify your codai identity
            profile: See your name and profile picture
            email: See your email address
            inference: Run AI inference through your codai account
            keys:manage: Create and manage codai API keys on your behalf
            usage:read: Read your codai usage statistics
            subscriptions:read: Read your codai subscription plan
            mcp: Use codai tools and memory from an MCP client
            offline_access: Stay signed in on this device
        deviceCode:
          deviceAuthorizationUrl: https://auth.codai.ro/device/auth
          tokenUrl: https://auth.codai.ro/token
          scopes:
            openid: Verify your codai identity
            profile: See your name and profile picture
            email: See your email address
            inference: Run AI inference through your codai account
            keys:manage: Create and manage codai API keys on your behalf
            usage:read: Read your codai usage statistics
            subscriptions:read: Read your codai subscription plan
            mcp: Use codai tools and memory from an MCP client
            offline_access: Stay signed in on this device
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth access token issued by `/token` (used by `/me` and `/connect/key`).
    clientSecretBasic:
      type: http
      scheme: basic
      description: '`client_secret_basic` client authentication. `client_secret_post` and `private_key_jwt` go in the form body instead; public clients send only `client_id`.'
x-refined-from:
- codai-ro-auth-openapi.json
- codai-ro-gateway-openapi.json
- codai-ro-resolve-openapi.json
- codai-ro-auth-openapi.yml
- codai-ro-gateway-openapi.yml
- codai-ro-resolve-openapi.yml