Nexla

Nexla Health API

The health API from Nexla — 5 operation(s) for health.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.nexla.com/dev-guides/nexla-api
📖
APIReference
https://docs.nexla.com/reference/nexla-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/authentication/nexla-authentication.yml
📖
Documentation
https://docs.nexla.com/genai-rag/
📖
APIReference
https://docs.nexla.com/dev-guides/mcp-tools/tools-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/openapi/nexla-health-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/conventions/nexla-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/errors/nexla-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/data-model/nexla-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/asyncapi/nexla-webhooks.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/mcp/nexla-tool-crosswalk.yml

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/nexla-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

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

OpenAPI Specification

nexla-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Nexla GenAI (RAG + MCPaaS) Health API
  description: Combined Nexla GenAI RAG API Service and MCPaaS
  version: v0.2.3.3-combined
tags:
- name: health
paths:
  /health:
    get:
      tags:
      - health
      summary: Health Check
      description: 'Basic liveness probe.


        Returns 200 if the application is running.

        Used by Kubernetes for liveness probes.'
      operationId: health_check_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
                title: Response Health Check Health Get
  /health/ready:
    get:
      tags:
      - health
      summary: Readiness Check
      description: 'Readiness probe with dependency checks.


        Checks connectivity to required services.

        Used by Kubernetes for readiness probes.'
      operationId: readiness_check_health_ready_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
  /v1/metrics:
    get:
      tags:
      - health
      summary: Metrics
      description: 'Prometheus metrics endpoint.


        Returns metrics in Prometheus text format.'
      operationId: metrics_v1_metrics_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /health/deep:
    get:
      tags:
      - health
      summary: Deep Health Check
      description: 'Deep health check with all components.


        Performs thorough checks of all dependencies.

        May take longer than the basic readiness check.'
      operationId: deep_health_check_health_deep_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
  /v1/status:
    get:
      tags:
      - health
      summary: System Status
      description: 'System status dashboard data.


        Returns comprehensive status information for monitoring dashboards.

        Queries real counts from the database when repositories are available.'
      operationId: system_status_v1_status_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemStatus'
components:
  schemas:
    ComponentHealth:
      properties:
        status:
          type: string
          title: Status
        latency_ms:
          anyOf:
          - type: integer
          - type: 'null'
          title: Latency Ms
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
      type: object
      required:
      - status
      title: ComponentHealth
      description: Health status of a single component.
    SystemStatus:
      properties:
        status:
          type: string
          title: Status
        version:
          type: string
          title: Version
        environment:
          type: string
          title: Environment
        uptime_seconds:
          type: number
          title: Uptime Seconds
        active_sessions:
          type: integer
          title: Active Sessions
        total_tool_sets:
          type: integer
          title: Total Tool Sets
        total_tools:
          type: integer
          title: Total Tools
        rate_limit_type:
          type: string
          title: Rate Limit Type
        timestamp:
          type: string
          format: date-time
          title: Timestamp
      type: object
      required:
      - status
      - version
      - environment
      - uptime_seconds
      - active_sessions
      - total_tool_sets
      - total_tools
      - rate_limit_type
      - timestamp
      title: SystemStatus
      description: System status dashboard data.
    HealthStatus:
      properties:
        status:
          type: string
          title: Status
        version:
          type: string
          title: Version
        environment:
          type: string
          title: Environment
        components:
          additionalProperties:
            $ref: '#/components/schemas/ComponentHealth'
          type: object
          title: Components
        timestamp:
          type: string
          format: date-time
          title: Timestamp
      type: object
      required:
      - status
      - version
      - environment
      - timestamp
      title: HealthStatus
      description: System health check response.