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

# Platform compatibility

> The platform release this API runs, the latest SDK and CLI releases built with it, and the SDK and CLI major versions it supports, so a client can tell whether it is compatible. Requires authentication; open to every authenticated user.



## OpenAPI

````yaml https://api.galtea.ai/openapi.json get /platform-compatibility
openapi: 3.0.0
info:
  version: 1.0.0
  title: Product Management Service API
  description: API documentation for Product Management Service
  contact:
    name: Galtea AI
servers:
  - url: https://api.galtea.ai
security:
  - bearerAuth: []
tags: []
externalDocs:
  description: Galtea Platform Documentation
  url: https://docs.galtea.ai
paths:
  /platform-compatibility:
    get:
      tags: []
      summary: Platform compatibility
      description: >-
        The platform release this API runs, the latest SDK and CLI releases
        built with it, and the SDK and CLI major versions it supports, so a
        client can tell whether it is compatible. Requires authentication; open
        to every authenticated user.
      operationId: getPlatformCompatibility
      responses:
        '200':
          description: Platform version and supported client versions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformCompatibility'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    PlatformCompatibility:
      type: object
      properties:
        platform:
          type: string
          pattern: ^\d+\.\d+\.\d+$
          description: >-
            Platform release this API was built for. Absent on a development or
            preview build.
          example: 5.12.0
        sdk:
          $ref: '#/components/schemas/ClientCompatibility'
        cli:
          $ref: '#/components/schemas/ClientCompatibility'
      required:
        - sdk
        - cli
    Error:
      type: object
      properties:
        error:
          type: string
          example: Error type
        message:
          type: string
          example: Error message description
    ClientCompatibility:
      type: object
      properties:
        latest:
          type: string
          pattern: ^\d+\.\d+\.\d+$
          description: >-
            Latest release of the client built with this platform. Absent when
            the build did not record one.
          example: 5.12.0
        majors:
          type: array
          items:
            $ref: '#/components/schemas/SupportedMajor'
          description: >-
            Client major versions this platform supports. Empty when the
            platform version is unknown.
      required:
        - majors
    SupportedMajor:
      type: object
      properties:
        major:
          type: integer
          description: A supported major version of the client.
          example: 5
        endsOn:
          type: string
          nullable: true
          format: date
          description: >-
            Last day (`YYYY-MM-DD`) this platform supports the major. `null`
            while no end date is set.
          example: null
      required:
        - major
        - endsOn
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key authorization. Pass your API key in the Authorization header as
        a Bearer token. Both new (`gsk_*`) and legacy (`gsk-`) API keys are
        accepted, e.g. `Authorization: Bearer gsk_...` or `Authorization: Bearer
        gsk-...`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.