Vyond Parameter API

openapi: 3.2.0
info:
  title: Vyond API Documentation Parameter API
  version: 1.1.0
  description: 'APIs for getting parameters information

    '
tags:
- name: Parameter
  description: 'APIs for getting parameters information

    '
paths:
  /rest/v1/parameters/:
    get:
      operationId: ParameterController.getParameters
      parameters:
      - in: query
        name: feature
        required: true
        schema:
          type: string
          enum:
          - ai-avatar
          description: Target feature
      - in: query
        name: parameterKeys
        required: false
        schema:
          items:
            enum:
            - avatarProvider
            - avatarId
            - avatarBackground
            - avatarCustomBackground
            - languageCode
            - voiceProvider
            - voiceId
            - voiceEngine
            - voicePitch
            - voiceRate
            - voiceStyle
            type: string
          type: array
          description: Filter by parameter keys
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetParametersResBody'
          description: API parameters information
        '401':
          description: Unauthorized - missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Forbidden - missing required scope or invalid owner type, or user state validation
            failed
        '429':
          description: Too Many Requests - rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: Internal Server Error - unexpected error while retrieving parameters
      summary: Get API parameters information
      tags:
      - Parameter
      security:
      - bearer: []
      description: Get information (e.g. data type and values) of API parameters, some values may be filtered
        based on user plan and account available features.
components:
  schemas:
    Parameter:
      properties:
        key:
          enum:
          - avatarProvider
          - avatarId
          - avatarBackground
          - avatarCustomBackground
          - languageCode
          - voiceProvider
          - voiceId
          - voiceEngine
          - voicePitch
          - voiceRate
          - voiceStyle
          type: string
        name:
          type: string
        schema:
          type: object
          description: OpenAPI schema object
        values:
          items:
            $ref: '#/components/schemas/ValueObject'
          type: array
          description: Parameter values information
      type: object
      required:
      - key
      - name
      - schema
      - values
    ApiErrorResponse:
      properties:
        err:
          type: string
          description: Error code identifying the specific error
        reason:
          type: string
          description: Additional reason describing why the error occurred
        message:
          type: string
          description: Error message, used as an alternative to reason for non-enumerated error messages
        scimType:
          type: string
          description: SCIM error type, present on SCIM 409 Conflict responses (e.g. uniqueness)
        details:
          items:
            $ref: '#/components/schemas/ValidationDetail'
          type: array
          description: Validation error details, present when err is REQUEST_VALIDATION_FAILED
      type: object
      required:
      - err
    ComponentsObject:
      properties:
        schemas:
          type: object
          description: OpenAPI schema lookup by name, i.e. `Record<string, Schema>`
      type: object
      required:
      - schemas
    GetParametersResBody:
      properties:
        parameters:
          items:
            $ref: '#/components/schemas/Parameter'
          type: array
          description: Parameters available for the feature.
        components:
          $ref: '#/components/schemas/ComponentsObject'
          type: object
          description: OpenAPI components object
      type: object
      required:
      - parameters
      - components
    ValueObject:
      properties:
        value:
          not:
            type: 'null'
          description: Parameter value
        name:
          type: string
          description: Display name of the parameter value
        properties:
          type: object
          description: Properties of the parameter value
      type: object
      required:
      - value
    ValidationDetail:
      properties:
        property:
          type: string
          description: The property that failed validation
        message:
          items:
            type: string
          type: array
          description: Validation error messages for the property
      type: object
      required:
      - property
      - message
  securitySchemes:
    bearer:
      type: http
      scheme: bearer