> ## Documentation Index
> Fetch the complete documentation index at: https://docs.realitydefender.com/llms.txt
> Use this file to discover all available pages before exploring further.

# RealCall health

> Checks that the RealCall API is reachable and that your credentials are accepted. Returns `200` when they are. A `401` means the token or API key is missing or invalid. With a JWT, a `403` means your organization or user role cannot use RealCall; an API key never gets a `403`.



## OpenAPI

````yaml /openapi/realcall.json get /api/v1/realcall/health
openapi: 3.2.0
info:
  title: Reality Defender RealCall API
  version: 1.0.0
  description: >-
    The RealCall REST API provides programmatic access to real-time call
    analysis: streams, segments, test uploads, organization settings, API keys
    and webhooks.


    ## Getting started

    1. Create an API key in the Reality Defender web app under [API
    keys](https://app.realitydefender.ai/api-keys), or with `POST
    /api/v1/realcall/api-keys`. The plaintext key is shown only once, when it is
    created, so store it securely.

    2. Send the key in the `X-Api-Key` header on every request:


    ```bash

    curl -H "X-Api-Key: <your-key>" https://<host>/api/v1/realcall/settings

    ```


    ## Authentication

    Every request needs either an API key in the `X-Api-Key` header or a user
    access token in the `Authorization: Bearer <token>` header. An API key
    belongs to your organization and can call every RealCall operation;
    user-role restrictions apply only to bearer tokens. If a request sends both,
    the API key is used.


    ## Base path

    All endpoints are prefixed with `/api/v1/realcall/`.


    ## Conventions

    - `GET` — Retrieve one or more resources

    - `POST` — Create a new resource

    - `PUT` — Update an existing resource at a known identifier

    - `DELETE` — Permanently remove a resource


    ## Pagination

    List endpoints paginate by page: they accept `page` (zero-based, default 0)
    and `pageSize` (default 30, max 100), and return an `items` array alongside
    a `pagination` object with `currentPage`, `itemsPerPage` and `total`.


    ## Errors

    All error responses follow a consistent shape with `code`, `message`, and an
    optional `details` array.


    A `403` response has two meanings. With `code: org_not_enabled`, your
    organization does not have RealCall enabled; changing your user role does
    not fix it, so contact Reality Defender. A `403` without that code means
    your user role does not allow this operation. If both apply,
    `org_not_enabled` is returned. Neither is returned for requests made with an
    API key.
servers:
  - url: https://app.api.os.realitydefender.xyz
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: RealCall
    description: >-
      Real-time call analysis: streams, segments, test uploads, org settings,
      API keys and webhooks.
paths:
  /api/v1/realcall/health:
    get:
      tags:
        - RealCall
      summary: RealCall health
      description: >-
        Checks that the RealCall API is reachable and that your credentials are
        accepted. Returns `200` when they are. A `401` means the token or API
        key is missing or invalid. With a JWT, a `403` means your organization
        or user role cannot use RealCall; an API key never gets a `403`.
      operationId: getRealCallHealth
      responses:
        '200':
          description: The surface is serving requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      security:
        - BearerAuth:
            - REAL_CALL_READ_ACCESS
        - ApiKeyAuth: []
components:
  schemas:
    HealthResponse:
      type: object
      description: Liveness report for the RealCall REST surface.
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - ok
          description: Always `ok` when the surface is serving requests.
          example: ok
    Error:
      type: object
      description: Standard error response returned for all 4xx and 5xx status codes.
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Machine-readable error code.
          example: VALIDATION_ERROR
        message:
          type: string
          description: Human-readable description of the error.
          example: The request body contains invalid fields.
        details:
          type: array
          nullable: true
          description: Optional list of field-level validation errors.
          items:
            type: object
            properties:
              field:
                type: string
                description: The field path that caused the error.
                example: email
              issue:
                type: string
                description: A description of the issue with this field.
                example: Must be a valid email address.
    ErrorWithDetails:
      allOf:
        - $ref: '#/components/schemas/Error'
        - properties:
            details:
              type: array
              nullable: true
              description: Optional list of field-level validation errors.
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field path that caused the error.
                    example: email
                  issue:
                    type: string
                    description: A description of the issue with this field.
                    example: Must be a valid email address.
  responses:
    Unauthorized:
      description: Unauthorized. No valid credential was provided.
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - properties:
                  code:
                    example: UNAUTHORIZED
                  message:
                    example: Invalid or missing token
    Forbidden:
      description: >-
        Forbidden. The authenticated user does not have permission to perform
        this action.
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - properties:
                  code:
                    example: FORBIDDEN
    InternalServerError:
      description: Internal Server Error. An unexpected error occurred on the server.
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - properties:
                  code:
                    example: INTERNAL_SERVER_ERROR
    DefaultError:
      description: An error response in the standard shape.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorWithDetails'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token. Obtain a token via your identity provider and pass it
        in the `Authorization: Bearer <token>` header.
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Organization API key, sent in the `X-Api-Key` header. Create one in the
        web app under API keys. API-key requests are not subject to user-role
        restrictions.

````