API Plugin Example Manifest

 1apiVersion: smarter.sh/v1
 2kind: ApiPlugin
 3metadata:
 4  annotations: []
 5  description: Get additional information about the admin account of the Smarter platform.
 6  name: api_example
 7  pluginClass: api
 8  tags:
 9    - example.com
10    - api
11    - rest-api
12  version: 0.1.0
13spec:
14  apiData:
15    body:
16      - default: test
17        description: The test to run.
18        name: test
19        required: true
20        type: string
21      - default: test2
22        description: The second test to run.
23        name: test2
24        required: false
25        type: string
26    endpoint: /stackademy/course-catalogue/
27    headers:
28      - name: X-Debug-Request
29        value: true
30      - name: X-API-Key
31        value: your_api_key_here
32      - name: Content-Type
33        value: application/json
34      - name: Accept
35        value: application/json
36      - name: X-Request-ID
37        value: 12345
38    limit: 10
39    method: GET
40    parameters:
41      - default: 500.00
42        description: A ceiling on the maximum cost of the course.
43        enum: null
44        name: max_cost
45        required: false
46        type: string
47      - default: Python
48        description: A keyword to search for in the course description.
49        enum: null
50        name: description
51        required: false
52        type: string
53    testValues:
54      - name: username
55        value: admin
56      - name: limit
57        value: 1
58    urlParams: null
59  connection: smarter_test_api
60  prompt:
61    maxTokens: 2048
62    model: gpt-4o-mini
63    provider: openai
64    systemRole:
65      You are a helpful assistant for Smarter platform. You can provide
66      information about the admin account of the Smarter platform.
67
68    temperature: 0.5
69  selector:
70    directive: search_terms
71    searchTerms:
72      - admin
73      - Smarter
74      - account