security-copilot-plugins/beakStream.yaml at main · a-imran99/security-copilot-plugins · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
openapi: 3.0.3
info:
  title: BeakOps Stream API
  description: API to send content to Beak AI and stream responses.
  version: 1.0.0
servers:
  - url: https://ai-qa.beakops.com/api/bitc
paths:
  /runs/copilot/stream:
    post:
      summary: Send content to Beak AI (streaming response)
      operationId: beakStreamAPI
      security:
        - ApiKeyAuth: []
      parameters:
        - name: opengpts-user-id
          in: header
          required: true
          schema:
            type: string
          description: The BeakOps user ID.
        - name: emailid
          in: header
          required: true
          schema:
            type: string
            format: email
          description: The email ID of the user.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - content
                - assistant_id
              properties:
                content:
                  type: string
                  description: The message sent to the copilot.
                  example: Hi
                assistant_id:
                  type: string
                  description: Unique identifier of the copilot assistant.
                  example: cfb458bb-09d1-4131-8b03-2b6249750eed
      responses:
        '200':
          description: Streamed response from the copilot.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The response message from the copilot.
        '400':
          description: Bad request (e.g. invalid assistant_id).
        '401':
          description: Unauthorized (invalid API key).
        '500':
          description: Internal server error.
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: API-Key