Call2Me Health API

openapi: 3.2.0
info:
  title: Call2Me Health API
  description: '# Call2Me Voice AI Platform API


    Programmatic interface to build, deploy and operate voice AI agents that can place

    and receive phone calls in real time. Designed to be consumed by humans **and** by

    AI agent frameworks (function-calling LLMs, MCP servers, automation platforms like

    Composio, Pipedream, Zapier, n8n).


    ## What you can do


    - **Place outbound calls** — give an agent a phone number to dial; the AI handles

    the conversation end-to-end and returns a transcript + recording.

    - **Manage AI agents** — create personalities, attach voices, system prompts,

    knowledge bases and post-call actions.

    - **Schedule calls** — one-shot or recurring (cron-like) outbound calls.

    - **Knowledge base (RAG)** — upload documents/URLs so the agent answers from your

    data with reduced hallucination.

    - **Inbound** — provision phone numbers that route to your agents.


    ## Common LLM tool-calling use cases


    | Goal | Endpoint |

    |------|----------|

    | "Call this person and read them this script" | `POST /v1/calls` |

    | "Schedule a follow-up tomorrow at 14:00" | `POST /v1/schedules` |

    | "Get the transcript of last call" | `GET /v1/calls/{id}` |

    | "Add this PDF to the agent''s brain" | `POST /v1/knowledge-base/{id}/sources` |


    ## Authentication


    Every request requires a Bearer token issued from the dashboard:


    ```

    Authorization: Bearer c2m_sk_xxxxxxxxxxxxxxxx

    ```


    Get your API key from the API Keys page.

    Keys are scoped per-workspace and can be rotated/revoked any time.


    ## Rate Limits


    | Plan | Requests/min | Concurrent Calls |

    |------|-------------|------------------|

    | Free | 60 | 1 |

    | Pro | 600 | 10 |

    | Enterprise | Unlimited | Unlimited |


    ## SDKs & Integrations


    - Python SDK

    - Node.js SDK

    - OpenAPI 3.1 spec: `/openapi.json` (use it to generate clients or register the

    service with AI tool platforms)


    ## Support


    - Email: support@call2me.app

    - Docs: https://docs.call2me.app

    - Discord: https://discord.gg/call2me'
  version: 1.0.0
  x-logo:
    url: https://call2me.app/logo.png
    altText: Call2Me Logo
  contact:
    name: Call2Me Support
    url: https://call2me.app/support
    email: support@call2me.app
  license:
    name: Commercial — see Terms of Service
    url: https://call2me.app/terms
  termsOfService: https://call2me.app/terms
servers:
- url: https://api.call2me.app
  description: Production
- url: http://localhost:8000
  description: Local Development
security:
- BearerAuth: []
tags:
- name: Health
  description: API health and status endpoints — useful for monitors and load balancers.
paths:
  /health:
    get:
      tags:
      - Health
      summary: Health Check
      description: 'Check API health and dependencies.


        Returns status of API, database, and cache connections.'
      operationId: health_check_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
  /health/detailed:
    get:
      tags:
      - Health
      summary: Health Check Detailed
      description: 'Detailed health check for all services and dependencies.


        Returns comprehensive status including:

        - Database connectivity and pool stats

        - Redis connectivity

        - pgvector extension status

        - Database schema validation'
      operationId: health_check_detailed_health_detailed_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Health Check Detailed Health Detailed Get
  /health/ready:
    get:
      tags:
      - Health
      summary: Readiness Check
      description: 'Kubernetes-style readiness probe.


        Returns 200 if service is ready to receive traffic.'
      operationId: readiness_check_health_ready_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Readiness Check Health Ready Get
  /health/live:
    get:
      tags:
      - Health
      summary: Liveness Check
      description: 'Kubernetes-style liveness probe.


        Returns 200 if the service is running.'
      operationId: liveness_check_health_live_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
                title: Response Liveness Check Health Live Get
components:
  schemas:
    HealthResponse:
      properties:
        status:
          type: string
          title: Status
          description: 'Service status: healthy, degraded, unhealthy'
        service:
          type: string
          title: Service
          description: Service name
        version:
          type: string
          title: Version
          description: Service version
        timestamp:
          type: string
          format: date-time
          title: Timestamp
        checks:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Checks
          description: Individual health checks
      type: object
      required:
      - status
      - service
      - version
      title: HealthResponse
      description: Health check response.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: Enter your API key
externalDocs:
  description: Full developer documentation
  url: https://docs.call2me.app