> ## 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 ``` 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.1.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. - name: Schedule Configs description: Create and manage retry policies for scheduled outbound calls. 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_' '500': description: Unexpected server error with a request ID for support correlation. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 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 - meta title: ApiResponse[HealthStatus] ErrorResponse: properties: error: oneOf: - $ref: '#/components/schemas/ValidationErrorPayload' - $ref: '#/components/schemas/UnauthorizedPayload' - $ref: '#/components/schemas/NotFoundPayload' - $ref: '#/components/schemas/InternalErrorPayload' - $ref: '#/components/schemas/PhoneNumberBlockedPayload' - $ref: '#/components/schemas/CallLimitExceededPayload' - $ref: '#/components/schemas/OutboundCallFailedPayload' - $ref: '#/components/schemas/ScenarioNotFoundPayload' - $ref: '#/components/schemas/ScenarioForbiddenPayload' - $ref: '#/components/schemas/ScenarioInvalidConfigPayload' - $ref: '#/components/schemas/NoOrganizationPayload' - $ref: '#/components/schemas/CallNotFoundPayload' - $ref: '#/components/schemas/OauthInvalidRedirectUriPayload' - $ref: '#/components/schemas/SchedulingDisabledPayload' - $ref: '#/components/schemas/InvalidScheduleTimePayload' - $ref: '#/components/schemas/ScheduleConfigNotFoundPayload' - $ref: '#/components/schemas/CallNotPendingPayload' title: Error discriminator: propertyName: type mapping: call_limit_exceeded: '#/components/schemas/CallLimitExceededPayload' call_not_found: '#/components/schemas/CallNotFoundPayload' call_not_pending: '#/components/schemas/CallNotPendingPayload' internal_error: '#/components/schemas/InternalErrorPayload' invalid_schedule_time: '#/components/schemas/InvalidScheduleTimePayload' no_organization: '#/components/schemas/NoOrganizationPayload' not_found: '#/components/schemas/NotFoundPayload' oauth_invalid_redirect_uri: '#/components/schemas/OauthInvalidRedirectUriPayload' outbound_call_failed: '#/components/schemas/OutboundCallFailedPayload' phone_number_blocked: '#/components/schemas/PhoneNumberBlockedPayload' scenario_forbidden: '#/components/schemas/ScenarioForbiddenPayload' scenario_invalid_config: '#/components/schemas/ScenarioInvalidConfigPayload' scenario_not_found: '#/components/schemas/ScenarioNotFoundPayload' schedule_config_not_found: '#/components/schemas/ScheduleConfigNotFoundPayload' scheduling_disabled: '#/components/schemas/SchedulingDisabledPayload' unauthorized: '#/components/schemas/UnauthorizedPayload' validation_error: '#/components/schemas/ValidationErrorPayload' meta: $ref: '#/components/schemas/ResponseMeta' additionalProperties: false type: object required: - error - meta title: ErrorResponse description: >- Standard envelope for all public API error responses. `error` is a discriminated union — branch on `error.type` to access variant-specific fields. Generated clients preserve unknown tagged variants so applications can log and surface newer server errors safely. 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. ValidationErrorPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: validation_error title: Type default: validation_error field_violations: items: $ref: '#/components/schemas/FieldViolation' type: array title: Field Violations description: Per-field validation details. additionalProperties: false type: object required: - message - field_violations - type title: ValidationErrorPayload UnauthorizedPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: unauthorized title: Type default: unauthorized additionalProperties: false type: object required: - message - type title: UnauthorizedPayload NotFoundPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: not_found title: Type default: not_found additionalProperties: false type: object required: - message - type title: NotFoundPayload InternalErrorPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: internal_error title: Type default: internal_error additionalProperties: false type: object required: - message - type title: InternalErrorPayload PhoneNumberBlockedPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: phone_number_blocked title: Type default: phone_number_blocked phone_number: type: string title: Phone Number description: The phone number that is blocked. additionalProperties: false type: object required: - message - phone_number - type title: PhoneNumberBlockedPayload CallLimitExceededPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: call_limit_exceeded title: Type default: call_limit_exceeded phone_number: type: string title: Phone Number description: The phone number that hit the limit. call_limit: type: integer title: Call Limit description: The per-number call limit that was reached. additionalProperties: false type: object required: - message - phone_number - call_limit - type title: CallLimitExceededPayload OutboundCallFailedPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: outbound_call_failed title: Type default: outbound_call_failed reason: type: string title: Reason description: Stable-ish reason string from the call service. additionalProperties: false type: object required: - message - reason - type title: OutboundCallFailedPayload ScenarioNotFoundPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: scenario_not_found title: Type default: scenario_not_found scenario_id: type: string title: Scenario Id additionalProperties: false type: object required: - message - scenario_id - type title: ScenarioNotFoundPayload ScenarioForbiddenPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: scenario_forbidden title: Type default: scenario_forbidden scenario_id: type: string title: Scenario Id additionalProperties: false type: object required: - message - scenario_id - type title: ScenarioForbiddenPayload ScenarioInvalidConfigPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: scenario_invalid_config title: Type default: scenario_invalid_config scenario_id: type: string title: Scenario Id additionalProperties: false type: object required: - message - scenario_id - type title: ScenarioInvalidConfigPayload NoOrganizationPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: no_organization title: Type default: no_organization additionalProperties: false type: object required: - message - type title: NoOrganizationPayload CallNotFoundPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: call_not_found title: Type default: call_not_found call_id: type: string title: Call Id additionalProperties: false type: object required: - message - call_id - type title: CallNotFoundPayload OauthInvalidRedirectUriPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: oauth_invalid_redirect_uri title: Type default: oauth_invalid_redirect_uri redirect_uri: type: string title: Redirect Uri additionalProperties: false type: object required: - message - redirect_uri - type title: OauthInvalidRedirectUriPayload SchedulingDisabledPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: scheduling_disabled title: Type default: scheduling_disabled additionalProperties: false type: object required: - message - type title: SchedulingDisabledPayload InvalidScheduleTimePayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: invalid_schedule_time title: Type default: invalid_schedule_time additionalProperties: false type: object required: - message - type title: InvalidScheduleTimePayload ScheduleConfigNotFoundPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: schedule_config_not_found title: Type default: schedule_config_not_found schedule_config_id: type: string title: Schedule Config Id additionalProperties: false type: object required: - message - schedule_config_id - type title: ScheduleConfigNotFoundPayload CallNotPendingPayload: properties: message: type: string title: Message description: >- Human-readable summary. Do not parse programmatically — branch on `type`. type: type: string const: call_not_pending title: Type default: call_not_pending status: anyOf: - type: string - type: 'null' title: Status additionalProperties: false type: object required: - message - status - type title: CallNotPendingPayload FieldViolation: properties: field: type: string title: Field description: >- Dot-separated path to the invalid field (e.g. `phone_number.country_code`). examples: - phone_number.country_code message: type: string title: Message description: Human-readable description of the violation. examples: - Must start with + additionalProperties: false type: object required: - field - message title: FieldViolation securitySchemes: ApiKeyAuth: type: http scheme: bearer description: >- API key from your Sarj.ai dashboard. Pass as: Authorization: Bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.