Revyze Coach API

The Coach API from Revyze — 1 operation(s) for coach.

OpenAPI Specification

revyze-coach-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Fast Admin Coach API
  version: 0.1.0
tags:
- name: Coach
paths:
  /coach/stream:
    post:
      summary: Coach Stream
      operationId: coach_stream_coach_stream_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CoachStreamInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Coach
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CoachMaterialType:
      type: string
      enum:
      - IMAGE
      - PDF
      title: CoachMaterialType
    CoachStreamInput:
      properties:
        content:
          type: string
          title: Content
        thread_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Thread Id
        materials:
          items:
            $ref: '#/components/schemas/MaterialInput'
          type: array
          title: Materials
          default: []
      type: object
      required:
      - content
      title: CoachStreamInput
    MaterialInput:
      properties:
        filename:
          type: string
          title: Filename
        type:
          $ref: '#/components/schemas/CoachMaterialType'
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
      type: object
      required:
      - filename
      - type
      title: MaterialInput