Sarj AI Developer API System API

openapi: 3.2.0
info:
  title: Sarj Ai Developer System API
  version: 1.0.0
  license:
    name: Apache 2.0
    identifier: Apache-2.0
  description: 'Operations tagged System across 2 of this provider''s published API definitions: sarj-ai-developer-api-developer-openapi.json, sarj-ai-developer-api-system-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://platform-api.sarj.ai/api/v1
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: System
  description: Service health and status.
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\n\nresponse = requests.get(\n    \"https://platform-api.sarj.ai/api/v1/health\"\n)\nprint(response.json())"
      - label: TypeScript
        lang: TypeScript
        source: "const response = await fetch(\n  \"https://platform-api.sarj.ai/api/v1/health\"\n);\nconst data = await response.json();\nconsole.log(data);"
    servers:
    - url: https://platform-api.sarj.ai/api/v1
      description: Production
components:
  schemas:
    ApiResponse_HealthStatus_:
      properties:
        data:
          $ref: '#/components/schemas/HealthStatus'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      additionalProperties: false
      type: object
      required:
      - data
      title: ApiResponse[HealthStatus]
    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.
    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.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: 'API key from your Sarj.ai dashboard. Pass as: Authorization: Bearer <api-key>'
externalDocs:
  description: Sarj.ai Documentation
  url: https://platform-docs.sarj.ai
x-refined-from:
- sarj-ai-developer-api-developer-openapi.json
- sarj-ai-developer-api-system-api-openapi.yml