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/chatrail-dev:chatrail-dev-operational-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 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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: ChatRail Operational API
  version: 1.0.0
  description: 'Send, schedule and receive WhatsApp messages through a linked-device session.


    **Two things the API is careful about, which shape every endpoint below.**


    *Accepted is not delivered.* A 202 means the message is durably stored and queued. Only the `status` field ever claims WhatsApp delivered anything, and `queued`, `submitted`, `sent`, `delivered` and `read` are deliberately distinct.


    *A retry must not send twice.* Send `Idempotency-Key` on every send. A replay returns the original response; a concurrent duplicate is told to retry rather than allowed to race.'
  contact:
    name: ChatRail
    url: https://www.chatrail.dev
servers:
- url: https://www.chatrail.dev
security:
- apiKey: []
tags:
- name: Operational
  description: Health and metrics.
paths:
  /healthz:
    get:
      summary: Liveness
      description: Never checks dependencies. Point a restart policy here, not a traffic probe.
      tags:
      - Operational
      operationId: get_healthz
      responses:
        '200':
          description: The process is alive.
      security: []
  /healthz/worker:
    get:
      summary: Worker liveness
      description: 'Whether the background worker has recorded a heartbeat in the last five minutes. For an external uptime monitor: the worker runs the other alerts, so it cannot report its own death.'
      tags:
      - Operational
      operationId: get_healthz_worker
      responses:
        '200':
          description: The worker is alive.
        '503':
          description: No heartbeat in five minutes, or none ever recorded.
      security: []
  /readyz:
    get:
      summary: Readiness
      description: Checks dependencies. Point the load balancer here.
      tags:
      - Operational
      operationId: get_readyz
      responses:
        '200':
          description: Ready.
        '503':
          description: A dependency is unavailable.
      security: []
  /metrics:
    get:
      summary: Prometheus metrics
      description: Not registered unless `METRICS_TOKEN` is configured. No label carries a workspace, connection, number or session name.
      tags:
      - Operational
      operationId: get_metrics
      responses:
        '200':
          description: Exposition format.
        '401':
          description: Missing or wrong token.
      security: []
  /v1/openapi.json:
    get:
      summary: This document
      tags:
      - Operational
      operationId: get_v1_openapi_json
      responses:
        '200':
          description: The OpenAPI document.
      security: []
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'A workspace API key, `cr_live_…`. Server-side only: it carries workspace authority and must never reach a browser.'
    session:
      type: apiKey
      in: cookie
      name: chatrail_session
      description: Dashboard session cookie. Set by `/v1/auth/verify`.