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

# Health Check

> Returns the operational status of the API. Does not require authentication.



## OpenAPI

````yaml /api-reference/openapi.json get /health
openapi: 3.1.0
info:
  title: Sarj.ai Developer API
  description: >
    Public API for programmatic access to the **Sarj.ai voice platform**.


    > [!TIP]

    > **New here?** Start with the [Getting Started
    guide](https://platform-docs.sarj.ai/getting-started)

    > to go from API key to first call in under 5 minutes.

    >

    > **Building with AI agents?** See the [MCP Server
    guide](https://platform-docs.sarj.ai/mcp-server)

    > to connect Claude Code, Cursor, or any MCP-compatible agent.


    ---


    ## Authentication


    All authenticated endpoints require a **Bearer token** in the
    `Authorization`

    header:


    ```

    Authorization: Bearer <your-api-key>

    ```


    Generate an API key from
    [platform.sarj.ai/api-keys](https://platform.sarj.ai/api-keys).


    > [!WARNING]

    > If you receive a `401 Unauthorized` response, your key may be invalid,

    > expired, or missing. Check the `error.type` field in the response body.


    ---


    ## Response Format


    **Success**


    ```json

    {
      "data": { ... },
      "meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000" }
    }

    ```


    **Error**


    ```json

    {
      "error": {
        "type": "unauthorized",
        "message": "Authentication required."
      },
      "meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000" }
    }

    ```


    Always branch on `error.type` — the `message` field is for humans only.


    ---


    ## Support


    Include `meta.request_id` in all support tickets for faster resolution.
  license:
    name: Apache 2.0
    identifier: Apache-2.0
  version: 1.0.0
servers:
  - url: https://platform-api.sarj.ai/api/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: System
    description: Service health and status.
  - name: Calls
    description: Create outbound voice calls and retrieve call details and transcripts.
externalDocs:
  description: Sarj.ai Documentation
  url: https://platform-docs.sarj.ai
paths:
  /health:
    get:
      tags:
        - System
      summary: Health Check
      description: >-
        Returns the operational status of the API. Does not require
        authentication.
      operationId: getHealth
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_HealthStatus_'
      security: []
      x-codeSamples:
        - label: Python (SDK)
          lang: Python
          source: |-
            import os
            from sarj_platform_sdk import SDK

            sdk = SDK(api_key_auth=os.environ.get("SARJ_API_KEY", ""))
            print(sdk.system.get_health().data.status)  # "ok"
        - label: Python (requests)
          lang: Python
          source: |-
            import requests

            response = requests.get(
                "https://platform-api.sarj.ai/api/v1/health"
            )
            print(response.json())
        - label: TypeScript
          lang: TypeScript
          source: |-
            const response = await fetch(
              "https://platform-api.sarj.ai/api/v1/health"
            );
            const data = await response.json();
            console.log(data);
components:
  schemas:
    ApiResponse_HealthStatus_:
      properties:
        data:
          $ref: '#/components/schemas/HealthStatus'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      additionalProperties: false
      type: object
      required:
        - data
      title: ApiResponse[HealthStatus]
    HealthStatus:
      properties:
        status:
          type: string
          const: ok
          title: Status
          description: >-
            Health status of the API. Always `ok` when this endpoint responds
            successfully.
          examples:
            - ok
      additionalProperties: false
      type: object
      required:
        - status
      title: HealthStatus
      description: Represents the operational status of the API.
    ResponseMeta:
      properties:
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: >-
            Unique identifier for this request, mirrored in the `X-Request-ID`
            response header. Supply your own via the `X-Request-ID` request
            header (max 128 chars, ASCII printable); otherwise the server
            generates a UUID v4. Include in support tickets.
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
      additionalProperties: false
      type: object
      title: ResponseMeta
      description: Contains request-level metadata included with every public API response.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        API key from your Sarj.ai dashboard. Pass as: Authorization: Bearer
        <api-key>

````