@inductiv/node-red-openai-api 0.3.8 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -0
- package/examples/assistants.json +60 -82
- package/examples/audio.json +182 -63
- package/examples/files.json +70 -32
- package/examples/images.json +56 -28
- package/lib.js +666 -688
- package/locales/de-DE/node.json +2 -1
- package/locales/en-US/node.json +1 -1
- package/locales/ja/node.json +2 -1
- package/locales/zh-CN/node.json +2 -1
- package/node.html +2562 -572
- package/node.js +61 -98
- package/package.json +2 -3
package/node.html
CHANGED
|
@@ -1,779 +1,2769 @@
|
|
|
1
1
|
<script type="text/javascript">
|
|
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
|
-
|
|
2
|
+
RED.nodes.registerType("OpenAI API", {
|
|
3
|
+
category: "AI",
|
|
4
|
+
color: "#B8B1FB",
|
|
5
|
+
defaults: {
|
|
6
|
+
name: { value: "" },
|
|
7
|
+
service: { value: "", type: "Service Host", required: true },
|
|
8
|
+
method: { value: "", required: true },
|
|
9
|
+
},
|
|
10
|
+
inputs: 1,
|
|
11
|
+
outputs: 1,
|
|
12
|
+
icon: "icon.png",
|
|
13
|
+
label: function () {
|
|
14
|
+
return this.name || this.method || "OpenAI API";
|
|
15
|
+
},
|
|
16
|
+
labelStyle: function () {
|
|
17
|
+
return this.name ? "node_label_italic" : "";
|
|
18
|
+
},
|
|
19
|
+
oneditprepare: function () {
|
|
20
|
+
var selectedMethod = $("#node-input-method option:selected");
|
|
21
|
+
if (!selectedMethod.val()) {
|
|
22
|
+
var methods = $("#node-input-method").children();
|
|
23
|
+
var firstMethod = methods.first();
|
|
24
|
+
$("#node-input-method").val(firstMethod.val());
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
});
|
|
28
28
|
</script>
|
|
29
29
|
|
|
30
30
|
<script type="text/html" data-template-name="OpenAI API">
|
|
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
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
31
|
+
<div class="form-row">
|
|
32
|
+
<label for="node-input-name"
|
|
33
|
+
><i class="fa fa-tag"></i>
|
|
34
|
+
<span data-i18n="node-red:common.label.name"></span
|
|
35
|
+
></label>
|
|
36
|
+
<input
|
|
37
|
+
type="text"
|
|
38
|
+
id="node-input-name"
|
|
39
|
+
data-i18n="[placeholder]node-red:common.label.name"
|
|
40
|
+
/>
|
|
41
|
+
</div>
|
|
42
|
+
<hr />
|
|
43
|
+
|
|
44
|
+
<div class="form-row">
|
|
45
|
+
<label for="node-input-service"
|
|
46
|
+
><i class="fa fa-cloud"></i>
|
|
47
|
+
<span data-i18n="OpenaiApi.label.serviceHost"></span
|
|
48
|
+
></label>
|
|
49
|
+
<input type="text" id="node-input-service" />
|
|
50
|
+
</div>
|
|
51
|
+
|
|
52
|
+
<div class="form-row">
|
|
53
|
+
<label for="node-input-method"
|
|
54
|
+
><i class="fa fa-tasks"></i>
|
|
55
|
+
<span data-i18n="OpenaiApi.label.method"></span
|
|
56
|
+
></label>
|
|
57
|
+
<select id="node-input-method">
|
|
58
|
+
<optgroup style="font-style: normal;" label="🤖 Assistants (Beta)">
|
|
59
|
+
<option
|
|
60
|
+
value="createAssistant"
|
|
61
|
+
data-i18n="OpenaiApi.parameters.createAssistant"
|
|
62
|
+
></option>
|
|
63
|
+
<option
|
|
64
|
+
value="getAssistant"
|
|
65
|
+
data-i18n="OpenaiApi.parameters.getAssistant"
|
|
66
|
+
></option>
|
|
67
|
+
<option
|
|
68
|
+
value="modifyAssistant"
|
|
69
|
+
data-i18n="OpenaiApi.parameters.modifyAssistant"
|
|
70
|
+
></option>
|
|
71
|
+
<option
|
|
72
|
+
value="deleteAssistant"
|
|
73
|
+
data-i18n="OpenaiApi.parameters.deleteAssistant"
|
|
74
|
+
></option>
|
|
75
|
+
<option
|
|
76
|
+
value="listAssistants"
|
|
77
|
+
data-i18n="OpenaiApi.parameters.listAssistants"
|
|
78
|
+
></option>
|
|
79
|
+
<option
|
|
80
|
+
value="listAssistantFiles"
|
|
81
|
+
data-i18n="OpenaiApi.parameters.listAssistantFiles"
|
|
82
|
+
></option>
|
|
83
|
+
<option
|
|
84
|
+
value="createAssistantFile"
|
|
85
|
+
data-i18n="OpenaiApi.parameters.createAssistantFile"
|
|
86
|
+
></option>
|
|
87
|
+
<option
|
|
88
|
+
value="getAssistantFile"
|
|
89
|
+
data-i18n="OpenaiApi.parameters.getAssistantFile"
|
|
90
|
+
></option>
|
|
91
|
+
<option
|
|
92
|
+
value="deleteAssistantFile"
|
|
93
|
+
data-i18n="OpenaiApi.parameters.deleteAssistantFile"
|
|
94
|
+
></option>
|
|
95
|
+
</optgroup>
|
|
96
|
+
<optgroup style="font-style: normal;" label="🔉 Audio">
|
|
97
|
+
<option
|
|
98
|
+
value="createSpeech"
|
|
99
|
+
data-i18n="OpenaiApi.parameters.createSpeech"
|
|
100
|
+
></option>
|
|
101
|
+
<option
|
|
102
|
+
value="createTranscription"
|
|
103
|
+
data-i18n="OpenaiApi.parameters.createTranscription"
|
|
104
|
+
></option>
|
|
105
|
+
<option
|
|
106
|
+
value="createTranslation"
|
|
107
|
+
data-i18n="OpenaiApi.parameters.createTranslation"
|
|
108
|
+
></option>
|
|
109
|
+
</optgroup>
|
|
110
|
+
<optgroup style="font-style: normal;" label="🗨️ Chat">
|
|
111
|
+
<option
|
|
112
|
+
value="createChatCompletion"
|
|
113
|
+
data-i18n="OpenaiApi.parameters.createChatCompletion"
|
|
114
|
+
></option>
|
|
115
|
+
</optgroup>
|
|
116
|
+
<optgroup style="font-style: normal;" label="🔗 Embeddings">
|
|
117
|
+
<option
|
|
118
|
+
value="createEmbedding"
|
|
119
|
+
data-i18n="OpenaiApi.parameters.createEmbedding"
|
|
120
|
+
></option>
|
|
121
|
+
</optgroup>
|
|
122
|
+
<optgroup style="font-style: normal;" label="🔧 Fine-tuning">
|
|
123
|
+
<option
|
|
124
|
+
value="createFineTuningJob"
|
|
125
|
+
data-i18n="OpenaiApi.parameters.createFineTuningJob"
|
|
126
|
+
></option>
|
|
127
|
+
<option
|
|
128
|
+
value="listPaginatedFineTuningJobs"
|
|
129
|
+
data-i18n="OpenaiApi.parameters.listPaginatedFineTuningJobs"
|
|
130
|
+
></option>
|
|
131
|
+
<option
|
|
132
|
+
value="retrieveFineTuningJob"
|
|
133
|
+
data-i18n="OpenaiApi.parameters.retrieveFineTuningJob"
|
|
134
|
+
></option>
|
|
135
|
+
<option
|
|
136
|
+
value="listFineTuningEvents"
|
|
137
|
+
data-i18n="OpenaiApi.parameters.listFineTuningEvents"
|
|
138
|
+
></option>
|
|
139
|
+
<option
|
|
140
|
+
value="cancelFineTuningJob"
|
|
141
|
+
data-i18n="OpenaiApi.parameters.cancelFineTuningJob"
|
|
142
|
+
></option>
|
|
143
|
+
</optgroup>
|
|
144
|
+
<optgroup style="font-style: normal;" label="📁 Files">
|
|
145
|
+
<option
|
|
146
|
+
value="listFiles"
|
|
147
|
+
data-i18n="OpenaiApi.parameters.listFiles"
|
|
148
|
+
></option>
|
|
149
|
+
<option
|
|
150
|
+
value="createFile"
|
|
151
|
+
data-i18n="OpenaiApi.parameters.uploadFile"
|
|
152
|
+
></option>
|
|
153
|
+
<option
|
|
154
|
+
value="deleteFile"
|
|
155
|
+
data-i18n="OpenaiApi.parameters.deleteFile"
|
|
156
|
+
></option>
|
|
157
|
+
<option
|
|
158
|
+
value="retrieveFile"
|
|
159
|
+
data-i18n="OpenaiApi.parameters.retrieveFile"
|
|
160
|
+
></option>
|
|
161
|
+
<option
|
|
162
|
+
value="downloadFile"
|
|
163
|
+
data-i18n="OpenaiApi.parameters.downloadFile"
|
|
164
|
+
></option>
|
|
165
|
+
</optgroup>
|
|
166
|
+
<optgroup style="font-style: normal;" label="🖼️ Images">
|
|
167
|
+
<option
|
|
168
|
+
value="createImage"
|
|
169
|
+
data-i18n="OpenaiApi.parameters.createImage"
|
|
170
|
+
></option>
|
|
171
|
+
<option
|
|
172
|
+
value="createImageEdit"
|
|
173
|
+
data-i18n="OpenaiApi.parameters.createImageEdit"
|
|
174
|
+
></option>
|
|
175
|
+
<option
|
|
176
|
+
value="createImageVariation"
|
|
177
|
+
data-i18n="OpenaiApi.parameters.createImageVariation"
|
|
178
|
+
></option>
|
|
179
|
+
</optgroup>
|
|
180
|
+
<optgroup style="font-style: normal;" label="📟 Messages (Beta)">
|
|
181
|
+
<option
|
|
182
|
+
value="listMessages"
|
|
183
|
+
data-i18n="OpenaiApi.parameters.listMessages"
|
|
184
|
+
></option>
|
|
185
|
+
<option
|
|
186
|
+
value="createMessage"
|
|
187
|
+
data-i18n="OpenaiApi.parameters.createMessage"
|
|
188
|
+
></option>
|
|
189
|
+
<option
|
|
190
|
+
value="getMessage"
|
|
191
|
+
data-i18n="OpenaiApi.parameters.getMessage"
|
|
192
|
+
></option>
|
|
193
|
+
<option
|
|
194
|
+
value="modifyMessage"
|
|
195
|
+
data-i18n="OpenaiApi.parameters.modifyMessage"
|
|
196
|
+
></option>
|
|
197
|
+
<option
|
|
198
|
+
value="listMessageFiles"
|
|
199
|
+
data-i18n="OpenaiApi.parameters.listMessageFiles"
|
|
200
|
+
></option>
|
|
201
|
+
<option
|
|
202
|
+
value="getMessageFile"
|
|
203
|
+
data-i18n="OpenaiApi.parameters.getMessageFile"
|
|
204
|
+
></option>
|
|
205
|
+
</optgroup>
|
|
206
|
+
<optgroup style="font-style: normal;" label="🧠 Models">
|
|
207
|
+
<option
|
|
208
|
+
value="listModels"
|
|
209
|
+
data-i18n="OpenaiApi.parameters.listModels"
|
|
210
|
+
></option>
|
|
211
|
+
<option
|
|
212
|
+
value="retrieveModel"
|
|
213
|
+
data-i18n="OpenaiApi.parameters.retrieveModel"
|
|
214
|
+
></option>
|
|
215
|
+
<option
|
|
216
|
+
value="deleteModel"
|
|
217
|
+
data-i18n="OpenaiApi.parameters.deleteModel"
|
|
218
|
+
></option>
|
|
219
|
+
</optgroup>
|
|
220
|
+
<optgroup style="font-style: normal;" label="✅ Moderations">
|
|
221
|
+
<option
|
|
222
|
+
value="createModeration"
|
|
223
|
+
data-i18n="OpenaiApi.parameters.createModeration"
|
|
224
|
+
></option>
|
|
225
|
+
</optgroup>
|
|
226
|
+
<optgroup style="font-style: normal;" label="🔄 Runs (Beta)">
|
|
227
|
+
<option
|
|
228
|
+
value="createThreadAndRun"
|
|
229
|
+
data-i18n="OpenaiApi.parameters.createThreadAndRun"
|
|
230
|
+
></option>
|
|
231
|
+
<option
|
|
232
|
+
value="listRuns"
|
|
233
|
+
data-i18n="OpenaiApi.parameters.listRuns"
|
|
234
|
+
></option>
|
|
235
|
+
<option
|
|
236
|
+
value="createRun"
|
|
237
|
+
data-i18n="OpenaiApi.parameters.createRun"
|
|
238
|
+
></option>
|
|
239
|
+
<option value="getRun" data-i18n="OpenaiApi.parameters.getRun"></option>
|
|
240
|
+
<option
|
|
241
|
+
value="modifyRun"
|
|
242
|
+
data-i18n="OpenaiApi.parameters.modifyRun"
|
|
243
|
+
></option>
|
|
244
|
+
<option
|
|
245
|
+
value="submitToolOuputsToRun"
|
|
246
|
+
data-i18n="OpenaiApi.parameters.submitToolOuputsToRun"
|
|
247
|
+
></option>
|
|
248
|
+
<option
|
|
249
|
+
value="cancelRun"
|
|
250
|
+
data-i18n="OpenaiApi.parameters.cancelRun"
|
|
251
|
+
></option>
|
|
252
|
+
<option
|
|
253
|
+
value="listRunSteps"
|
|
254
|
+
data-i18n="OpenaiApi.parameters.listRunSteps"
|
|
255
|
+
></option>
|
|
256
|
+
<option
|
|
257
|
+
value="getRunStep"
|
|
258
|
+
data-i18n="OpenaiApi.parameters.getRunStep"
|
|
259
|
+
></option>
|
|
260
|
+
</optgroup>
|
|
261
|
+
<optgroup style="font-style: normal;" label="🧵 Threads (Beta)">
|
|
262
|
+
<option
|
|
263
|
+
value="createThread"
|
|
264
|
+
data-i18n="OpenaiApi.parameters.createThread"
|
|
265
|
+
></option>
|
|
266
|
+
<option
|
|
267
|
+
value="getThread"
|
|
268
|
+
data-i18n="OpenaiApi.parameters.getThread"
|
|
269
|
+
></option>
|
|
270
|
+
<option
|
|
271
|
+
value="modifyThread"
|
|
272
|
+
data-i18n="OpenaiApi.parameters.modifyThread"
|
|
273
|
+
></option>
|
|
274
|
+
<option
|
|
275
|
+
value="deleteThread"
|
|
276
|
+
data-i18n="OpenaiApi.parameters.deleteThread"
|
|
277
|
+
></option>
|
|
278
|
+
</optgroup>
|
|
279
|
+
</select>
|
|
280
|
+
</div>
|
|
121
281
|
</script>
|
|
122
282
|
|
|
123
283
|
<script type="text/html" data-help-name="OpenAI API">
|
|
124
|
-
|
|
125
|
-
|
|
284
|
+
<p>
|
|
285
|
+
OpenAI Platform Services API. Please see the
|
|
286
|
+
<a href="https://platform.openai.com/docs/api-reference" target="_blank"
|
|
287
|
+
>OpenAI API Reference</a
|
|
288
|
+
>
|
|
289
|
+
for more details.
|
|
290
|
+
</p>
|
|
291
|
+
<p><b>Reference</b></p>
|
|
126
292
|
|
|
127
|
-
|
|
293
|
+
<section>
|
|
128
294
|
<h1 style="font-weight: bold;">🤖 Assistants</h1>
|
|
129
|
-
<a
|
|
295
|
+
<a
|
|
296
|
+
href="https://platform.openai.com/docs/api-reference/assistants"
|
|
297
|
+
target="_blank"
|
|
298
|
+
>Official Documentation
|
|
299
|
+
<i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
300
|
+
></a>
|
|
130
301
|
<h2>Create Assistant</h2>
|
|
131
302
|
<p>Create an assistant with a model and instructions.</p>
|
|
132
303
|
<dl class="message-properties">
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
<
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
304
|
+
<h2>msg.payload Properties</h2>
|
|
305
|
+
|
|
306
|
+
<dt>
|
|
307
|
+
model
|
|
308
|
+
<a
|
|
309
|
+
href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-model"
|
|
310
|
+
target="_blank"
|
|
311
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
312
|
+
></a>
|
|
313
|
+
<span class="property-type">string</span>
|
|
314
|
+
</dt>
|
|
315
|
+
<dd>ID of the model to use.</dd>
|
|
316
|
+
<dt class="optional">
|
|
317
|
+
name
|
|
318
|
+
<a
|
|
319
|
+
href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-name"
|
|
320
|
+
target="_blank"
|
|
321
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
322
|
+
></a>
|
|
323
|
+
<span class="property-type">string</span>
|
|
324
|
+
</dt>
|
|
325
|
+
<dd>The name of the assistant.</dd>
|
|
326
|
+
<dt class="optional">
|
|
327
|
+
description
|
|
328
|
+
<a
|
|
329
|
+
href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-description"
|
|
330
|
+
target="_blank"
|
|
331
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
332
|
+
></a>
|
|
333
|
+
<span class="property-type">string</span>
|
|
334
|
+
</dt>
|
|
335
|
+
<dd>The description of the assistant.</dd>
|
|
336
|
+
<dt class="optional">
|
|
337
|
+
instructions
|
|
338
|
+
<a
|
|
339
|
+
href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-instructions"
|
|
340
|
+
target="_blank"
|
|
341
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
342
|
+
></a>
|
|
343
|
+
<span class="property-type">string</span>
|
|
344
|
+
</dt>
|
|
345
|
+
<dd>The system instructions that the assistant uses.</dd>
|
|
346
|
+
<dt class="optional">
|
|
347
|
+
tools
|
|
348
|
+
<a
|
|
349
|
+
href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-tools"
|
|
350
|
+
target="_blank"
|
|
351
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
352
|
+
></a>
|
|
353
|
+
<span class="property-type">array</span>
|
|
354
|
+
</dt>
|
|
355
|
+
<dd>A list of tool enabled on the assistant.</dd>
|
|
356
|
+
<dt class="optional">
|
|
357
|
+
file_ids
|
|
358
|
+
<a
|
|
359
|
+
href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-file_ids"
|
|
360
|
+
target="_blank"
|
|
361
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
362
|
+
></a>
|
|
363
|
+
<span class="property-type">array</span>
|
|
364
|
+
</dt>
|
|
365
|
+
<dd>A list of file IDs attached to this assistant.</dd>
|
|
366
|
+
<dt class="optional">
|
|
367
|
+
metadata
|
|
368
|
+
<a
|
|
369
|
+
href="https://platform.openai.com/docs/api-reference/assistants/createAssistant#assistants-createassistant-metadata"
|
|
370
|
+
target="_blank"
|
|
371
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
372
|
+
></a>
|
|
373
|
+
<span class="property-type">object</span>
|
|
374
|
+
</dt>
|
|
375
|
+
<dd>Set of 16 key-value pairs that can be attached to an object.</dd>
|
|
142
376
|
</dl>
|
|
143
377
|
|
|
144
378
|
<h2>Retrieve Assistant</h2>
|
|
145
379
|
<p>Retrieves an assistant.</p>
|
|
146
380
|
<dl class="message-properties">
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
381
|
+
<h2>msg.payload Properties</h2>
|
|
382
|
+
|
|
383
|
+
<dt>
|
|
384
|
+
assistant_id
|
|
385
|
+
<a
|
|
386
|
+
href="https://platform.openai.com/docs/api-reference/assistants/getAssistant#assistants-getassistant-assistant_id"
|
|
387
|
+
target="_blank"
|
|
388
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
389
|
+
></a>
|
|
390
|
+
<span class="property-type">string</span>
|
|
391
|
+
</dt>
|
|
392
|
+
<dd>The ID of the assistant to retrieve.</dd>
|
|
150
393
|
</dl>
|
|
151
394
|
|
|
152
395
|
<h2>Modify Assistant</h2>
|
|
153
396
|
<p>Modifies an assistant.</p>
|
|
154
397
|
<dl class="message-properties">
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
<
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
<
|
|
165
|
-
|
|
398
|
+
<h2>msg.payload Properties</h2>
|
|
399
|
+
|
|
400
|
+
<dt>
|
|
401
|
+
assistant_id
|
|
402
|
+
<a
|
|
403
|
+
href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-assistant_id"
|
|
404
|
+
target="_blank"
|
|
405
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
406
|
+
></a>
|
|
407
|
+
<span class="property-type">string</span>
|
|
408
|
+
</dt>
|
|
409
|
+
<dd>The ID of the assistant to modify.</dd>
|
|
410
|
+
<dt class="optional">
|
|
411
|
+
model
|
|
412
|
+
<a
|
|
413
|
+
href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-model"
|
|
414
|
+
target="_blank"
|
|
415
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
416
|
+
></a>
|
|
417
|
+
<span class="property-type">string</span>
|
|
418
|
+
</dt>
|
|
419
|
+
<dd>ID of the model to use.</dd>
|
|
420
|
+
<dt class="optional">
|
|
421
|
+
name
|
|
422
|
+
<a
|
|
423
|
+
href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-name"
|
|
424
|
+
target="_blank"
|
|
425
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
426
|
+
></a>
|
|
427
|
+
<span class="property-type">string</span>
|
|
428
|
+
</dt>
|
|
429
|
+
<dd>The name of the assistant.</dd>
|
|
430
|
+
<dt class="optional">
|
|
431
|
+
description
|
|
432
|
+
<a
|
|
433
|
+
href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-description"
|
|
434
|
+
target="_blank"
|
|
435
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
436
|
+
></a>
|
|
437
|
+
<span class="property-type">string</span>
|
|
438
|
+
</dt>
|
|
439
|
+
<dd>The description of the assistant.</dd>
|
|
440
|
+
<dt class="optional">
|
|
441
|
+
instructions
|
|
442
|
+
<a
|
|
443
|
+
href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-instructions"
|
|
444
|
+
target="_blank"
|
|
445
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
446
|
+
></a>
|
|
447
|
+
<span class="property-type">string</span>
|
|
448
|
+
</dt>
|
|
449
|
+
<dd>The system instructions that the assistant uses.</dd>
|
|
450
|
+
<dt class="optional">
|
|
451
|
+
tools
|
|
452
|
+
<a
|
|
453
|
+
href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-tools"
|
|
454
|
+
target="_blank"
|
|
455
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
456
|
+
></a>
|
|
457
|
+
<span class="property-type">array</span>
|
|
458
|
+
</dt>
|
|
459
|
+
<dd>A list of tool enabled on the assistant.</dd>
|
|
460
|
+
<dt class="optional">
|
|
461
|
+
file_ids
|
|
462
|
+
<a
|
|
463
|
+
href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-file_ids"
|
|
464
|
+
target="_blank"
|
|
465
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
466
|
+
></a>
|
|
467
|
+
<span class="property-type">array</span>
|
|
468
|
+
</dt>
|
|
469
|
+
<dd>A list of File IDs attached to this assistant.</dd>
|
|
470
|
+
<dt class="optional">
|
|
471
|
+
metadata
|
|
472
|
+
<a
|
|
473
|
+
href="https://platform.openai.com/docs/api-reference/assistants/modifyAssistant#assistants-modifyassistant-metadata"
|
|
474
|
+
target="_blank"
|
|
475
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
476
|
+
></a>
|
|
477
|
+
<span class="property-type">object</span>
|
|
478
|
+
</dt>
|
|
479
|
+
<dd>Set of 16 key-value pairs that can be attached to an object.</dd>
|
|
166
480
|
</dl>
|
|
167
481
|
|
|
168
482
|
<h2>Delete Assistant</h2>
|
|
169
483
|
<p>Delete an assistant.</p>
|
|
170
484
|
<dl class="message-properties">
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
485
|
+
<h2>msg.payload Properties</h2>
|
|
486
|
+
|
|
487
|
+
<dt>
|
|
488
|
+
assistant_id
|
|
489
|
+
<a
|
|
490
|
+
href="https://platform.openai.com/docs/api-reference/assistants/deleteAssistant#assistants-deleteassistant-assistant_id"
|
|
491
|
+
target="_blank"
|
|
492
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
493
|
+
></a>
|
|
494
|
+
<span class="property-type">string</span>
|
|
495
|
+
</dt>
|
|
496
|
+
<dd>The ID of the assistant to delete.</dd>
|
|
174
497
|
</dl>
|
|
175
498
|
|
|
176
499
|
<h2>List Assistants</h2>
|
|
177
500
|
<p>Returns a list of assistants.</p>
|
|
178
501
|
<dl class="message-properties">
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
<
|
|
183
|
-
|
|
502
|
+
<h2>msg.payload Properties</h2>
|
|
503
|
+
<dt class="optional">
|
|
504
|
+
limit
|
|
505
|
+
<a
|
|
506
|
+
href="https://platform.openai.com/docs/api-reference/assistants/listAssistants#assistants-listassistants-limit"
|
|
507
|
+
target="_blank"
|
|
508
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
509
|
+
></a>
|
|
510
|
+
<span class="property-type">integer</span>
|
|
511
|
+
</dt>
|
|
512
|
+
<dd>A limit on the number of objects to be returned.</dd>
|
|
513
|
+
<dt class="optional">
|
|
514
|
+
order
|
|
515
|
+
<a
|
|
516
|
+
href="https://platform.openai.com/docs/api-reference/assistants/listAssistants#assistants-listassistants-order"
|
|
517
|
+
target="_blank"
|
|
518
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
519
|
+
></a>
|
|
520
|
+
<span class="property-type">string</span>
|
|
521
|
+
</dt>
|
|
522
|
+
<dd>Sort order by the created_at timestamp of the objects.</dd>
|
|
523
|
+
<dt class="optional">
|
|
524
|
+
after
|
|
525
|
+
<a
|
|
526
|
+
href="https://platform.openai.com/docs/api-reference/assistants/listAssistants#assistants-listassistants-after"
|
|
527
|
+
target="_blank"
|
|
528
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
529
|
+
></a>
|
|
530
|
+
<span class="property-type">string</span>
|
|
531
|
+
</dt>
|
|
532
|
+
<dd>A cursor for use in pagination.</dd>
|
|
533
|
+
<dt class="optional">
|
|
534
|
+
before
|
|
535
|
+
<a
|
|
536
|
+
href="https://platform.openai.com/docs/api-reference/assistants/listAssistants#assistants-listassistants-before"
|
|
537
|
+
target="_blank"
|
|
538
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
539
|
+
></a>
|
|
540
|
+
<span class="property-type">string</span>
|
|
541
|
+
</dt>
|
|
542
|
+
<dd>A cursor for use in pagination.</dd>
|
|
184
543
|
</dl>
|
|
185
544
|
|
|
186
545
|
<h2>List Assistant Files</h2>
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
546
|
+
<p>Returns a list of assistant files.</p>
|
|
547
|
+
<dl class="message-properties">
|
|
548
|
+
<h2>msg.payload Properties</h2>
|
|
549
|
+
|
|
550
|
+
<dt>
|
|
551
|
+
assistant_id
|
|
552
|
+
<a
|
|
553
|
+
href="https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-assistant_id"
|
|
554
|
+
target="_blank"
|
|
555
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
556
|
+
></a>
|
|
557
|
+
<span class="property-type">string</span>
|
|
558
|
+
</dt>
|
|
559
|
+
<dd>The ID of the assistant the file belongs to.</dd>
|
|
560
|
+
<dt class="optional">
|
|
561
|
+
limit
|
|
562
|
+
<a
|
|
563
|
+
href="https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-limit"
|
|
564
|
+
target="_blank"
|
|
565
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
566
|
+
></a>
|
|
567
|
+
<span class="property-type">integer</span>
|
|
568
|
+
</dt>
|
|
569
|
+
<dd>A limit on the number of objects to be returned.</dd>
|
|
570
|
+
<dt class="optional">
|
|
571
|
+
order
|
|
572
|
+
<a
|
|
573
|
+
href="https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-order"
|
|
574
|
+
target="_blank"
|
|
575
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
576
|
+
></a>
|
|
577
|
+
<span class="property-type">string</span>
|
|
578
|
+
</dt>
|
|
579
|
+
<dd>Sort order by the created_at timestamp of the objects.</dd>
|
|
580
|
+
<dt class="optional">
|
|
581
|
+
after
|
|
582
|
+
<a
|
|
583
|
+
href="https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-after"
|
|
584
|
+
target="_blank"
|
|
585
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
586
|
+
></a>
|
|
587
|
+
<span class="property-type">string</span>
|
|
588
|
+
</dt>
|
|
589
|
+
<dd>A cursor for use in pagination.</dd>
|
|
590
|
+
<dt class="optional">
|
|
591
|
+
before
|
|
592
|
+
<a
|
|
593
|
+
href="https://platform.openai.com/docs/api-reference/assistants/listAssistantFiles#assistants-listassistantfiles-before"
|
|
594
|
+
target="_blank"
|
|
595
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
596
|
+
></a>
|
|
597
|
+
<span class="property-type">string</span>
|
|
598
|
+
</dt>
|
|
599
|
+
<dd>A cursor for use in pagination.</dd>
|
|
600
|
+
</dl>
|
|
197
601
|
|
|
198
602
|
<h2>Create Assistant File</h2>
|
|
199
603
|
<p>Create an assistant file by attaching a file to an assistant.</p>
|
|
200
604
|
<dl class="message-properties">
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
<
|
|
605
|
+
<h2>msg.payload Properties</h2>
|
|
606
|
+
|
|
607
|
+
<dt>
|
|
608
|
+
assistant_id
|
|
609
|
+
<a
|
|
610
|
+
href="https://platform.openai.com/docs/api-reference/assistants/createAssistantFile#assistants-createassistantfile-assistant_id"
|
|
611
|
+
target="_blank"
|
|
612
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
613
|
+
></a>
|
|
614
|
+
<span class="property-type">string</span>
|
|
615
|
+
</dt>
|
|
616
|
+
<dd>The ID of the assistant for which to create a File.</dd>
|
|
617
|
+
<dt>
|
|
618
|
+
file_id
|
|
619
|
+
<a
|
|
620
|
+
href="https://platform.openai.com/docs/api-reference/assistants/createAssistantFile#assistants-createassistantfile-file_id"
|
|
621
|
+
target="_blank"
|
|
622
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
623
|
+
></a>
|
|
624
|
+
<span class="property-type">string</span>
|
|
625
|
+
</dt>
|
|
626
|
+
<dd>
|
|
627
|
+
A File ID (with purpose="assistants") that the assistant should use.
|
|
628
|
+
</dd>
|
|
206
629
|
</dl>
|
|
207
630
|
|
|
208
631
|
<h2>Retrieve Assistant File</h2>
|
|
209
632
|
<p>Retrieves an AssistantFile.</p>
|
|
210
633
|
<dl class="message-properties">
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
634
|
+
<h2>msg.payload Properties</h2>
|
|
635
|
+
|
|
636
|
+
<dt>
|
|
637
|
+
assistant_id
|
|
638
|
+
<a
|
|
639
|
+
href="https://platform.openai.com/docs/api-reference/assistants/getAssistantFile#assistants-getassistantfile-assistant_id"
|
|
640
|
+
target="_blank"
|
|
641
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
642
|
+
></a>
|
|
643
|
+
<span class="property-type">string</span>
|
|
644
|
+
</dt>
|
|
645
|
+
<dd>The ID of the assistant who the file belongs to.</dd>
|
|
646
|
+
<dt>
|
|
647
|
+
file_id
|
|
648
|
+
<a
|
|
649
|
+
href="https://platform.openai.com/docs/api-reference/assistants/getAssistantFile#assistants-getassistantfile-file_id"
|
|
650
|
+
target="_blank"
|
|
651
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
652
|
+
></a>
|
|
653
|
+
<span class="property-type">string</span>
|
|
654
|
+
</dt>
|
|
655
|
+
<dd>The ID of the file we're getting.</dd>
|
|
215
656
|
</dl>
|
|
216
657
|
|
|
217
658
|
<h2>Delete Assistant File</h2>
|
|
218
659
|
<p>Delete an assistant file.</p>
|
|
219
660
|
<dl class="message-properties">
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
661
|
+
<h2>msg.payload Properties</h2>
|
|
662
|
+
|
|
663
|
+
<dt>
|
|
664
|
+
assistant_id
|
|
665
|
+
<a
|
|
666
|
+
href="https://platform.openai.com/docs/api-reference/assistants/deleteAssistantFile#assistants-deleteassistantfile-assistant_id"
|
|
667
|
+
target="_blank"
|
|
668
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
669
|
+
></a>
|
|
670
|
+
<span class="property-type">string</span>
|
|
671
|
+
</dt>
|
|
672
|
+
<dd>The ID of the assistant that the file belongs to.</dd>
|
|
673
|
+
<dt>
|
|
674
|
+
file_id
|
|
675
|
+
<a
|
|
676
|
+
href="https://platform.openai.com/docs/api-reference/assistants/deleteAssistantFile#assistants-deleteassistantfile-file_id"
|
|
677
|
+
target="_blank"
|
|
678
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
679
|
+
></a>
|
|
680
|
+
<span class="property-type">string</span>
|
|
681
|
+
</dt>
|
|
682
|
+
<dd>The ID of the file to delete.</dd>
|
|
224
683
|
</dl>
|
|
225
|
-
|
|
684
|
+
</section>
|
|
226
685
|
|
|
227
|
-
|
|
686
|
+
<section>
|
|
228
687
|
<h1 style="font-weight: bold;">🔉 Audio</h1>
|
|
229
|
-
<a
|
|
688
|
+
<a
|
|
689
|
+
href="https://platform.openai.com/docs/api-reference/audio"
|
|
690
|
+
target="_blank"
|
|
691
|
+
>Official Documentation
|
|
692
|
+
<i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
693
|
+
></a>
|
|
230
694
|
<h2>Create Speech</h2>
|
|
231
695
|
<p>Generates audio from the input text.</p>
|
|
232
696
|
<dl class="message-properties">
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
<
|
|
238
|
-
|
|
239
|
-
|
|
697
|
+
<h2>msg.payload Properties</h2>
|
|
698
|
+
|
|
699
|
+
<dt>
|
|
700
|
+
model
|
|
701
|
+
<a
|
|
702
|
+
href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-model"
|
|
703
|
+
target="_blank"
|
|
704
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
705
|
+
></a>
|
|
706
|
+
<span class="property-type">string</span>
|
|
707
|
+
</dt>
|
|
708
|
+
<dd>One of the available TTS models: tts-1 or tts-1-hd</dd>
|
|
709
|
+
<dt>
|
|
710
|
+
input
|
|
711
|
+
<a
|
|
712
|
+
href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-input"
|
|
713
|
+
target="_blank"
|
|
714
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
715
|
+
></a>
|
|
716
|
+
<span class="property-type">string</span>
|
|
717
|
+
</dt>
|
|
718
|
+
<dd>The text to generate audio for.</dd>
|
|
719
|
+
<dt>
|
|
720
|
+
voice
|
|
721
|
+
<a
|
|
722
|
+
href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-voice"
|
|
723
|
+
target="_blank"
|
|
724
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
725
|
+
></a>
|
|
726
|
+
<span class="property-type">string</span>
|
|
727
|
+
</dt>
|
|
728
|
+
<dd>
|
|
729
|
+
The voice to use when generating the audio. Supported voices are alloy,
|
|
730
|
+
echo, fable, onyx, nova, and shimmer.
|
|
731
|
+
</dd>
|
|
732
|
+
<dt class="optional">
|
|
733
|
+
response_format
|
|
734
|
+
<a
|
|
735
|
+
href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-response_format"
|
|
736
|
+
target="_blank"
|
|
737
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
738
|
+
></a>
|
|
739
|
+
<span class="property-type">string</span>
|
|
740
|
+
</dt>
|
|
741
|
+
<dd>
|
|
742
|
+
The format to audio in. Supported formats are mp3, opus, aac, and flac.
|
|
743
|
+
</dd>
|
|
744
|
+
<dt class="optional">
|
|
745
|
+
speed
|
|
746
|
+
<a
|
|
747
|
+
href="https://platform.openai.com/docs/api-reference/audio/createSpeech#audio-createspeech-speed"
|
|
748
|
+
target="_blank"
|
|
749
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
750
|
+
></a>
|
|
751
|
+
<span class="property-type">number</span>
|
|
752
|
+
</dt>
|
|
753
|
+
<dd>
|
|
754
|
+
The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0
|
|
755
|
+
is the default.
|
|
756
|
+
</dd>
|
|
240
757
|
</dl>
|
|
241
758
|
|
|
242
759
|
<h2>Create Transcription</h2>
|
|
243
760
|
<p>Transcribes audio into the input language.</p>
|
|
244
761
|
<dl class="message-properties">
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
<
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
762
|
+
<h2>msg.payload Properties</h2>
|
|
763
|
+
|
|
764
|
+
<dt>
|
|
765
|
+
file
|
|
766
|
+
<a
|
|
767
|
+
href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-file"
|
|
768
|
+
target="_blank"
|
|
769
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
770
|
+
></a>
|
|
771
|
+
<span class="property-type">file</span>
|
|
772
|
+
</dt>
|
|
773
|
+
<dd>
|
|
774
|
+
Absolute path to the file that's being transcribed, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
|
|
775
|
+
</dd>
|
|
776
|
+
<dt>
|
|
777
|
+
model
|
|
778
|
+
<a
|
|
779
|
+
href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-model"
|
|
780
|
+
target="_blank"
|
|
781
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
782
|
+
></a>
|
|
783
|
+
<span class="property-type">string</span>
|
|
784
|
+
</dt>
|
|
785
|
+
<dd>ID of the model to use.</dd>
|
|
786
|
+
<dt class="optional">
|
|
787
|
+
language
|
|
788
|
+
<a
|
|
789
|
+
href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-language"
|
|
790
|
+
target="_blank"
|
|
791
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
792
|
+
></a>
|
|
793
|
+
<span class="property-type">string</span>
|
|
794
|
+
</dt>
|
|
795
|
+
<dd>The language of the input audio.</dd>
|
|
796
|
+
<dt class="optional">
|
|
797
|
+
prompt
|
|
798
|
+
<a
|
|
799
|
+
href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-prompt"
|
|
800
|
+
target="_blank"
|
|
801
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
802
|
+
></a>
|
|
803
|
+
<span class="property-type">string</span>
|
|
804
|
+
</dt>
|
|
805
|
+
<dd>
|
|
806
|
+
An optional text to guide the model's style or continue a previous audio
|
|
807
|
+
segment.
|
|
808
|
+
</dd>
|
|
809
|
+
<dt class="optional">
|
|
810
|
+
response_format
|
|
811
|
+
<a
|
|
812
|
+
href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-response_format"
|
|
813
|
+
target="_blank"
|
|
814
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
815
|
+
></a>
|
|
816
|
+
<span class="property-type">string</span>
|
|
817
|
+
</dt>
|
|
818
|
+
<dd>
|
|
819
|
+
The format of the transcript output, in one of these options: json,
|
|
820
|
+
text, srt, verbose_json, or vtt.
|
|
821
|
+
</dd>
|
|
822
|
+
<dt class="optional">
|
|
823
|
+
temperature
|
|
824
|
+
<a
|
|
825
|
+
href="https://platform.openai.com/docs/api-reference/audio/createTranscription#audio-createtranscription-temperature"
|
|
826
|
+
target="_blank"
|
|
827
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
828
|
+
></a>
|
|
829
|
+
<span class="property-type">number</span>
|
|
830
|
+
</dt>
|
|
831
|
+
<dd>The sampling temperature, between 0 and 1.</dd>
|
|
254
832
|
</dl>
|
|
255
833
|
|
|
256
834
|
<h2>Create Translation</h2>
|
|
257
835
|
<p>Translates audio into English.</p>
|
|
258
836
|
<dl class="message-properties">
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
<
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
837
|
+
<h2>msg.payload Properties</h2>
|
|
838
|
+
|
|
839
|
+
<dt>
|
|
840
|
+
file
|
|
841
|
+
<a
|
|
842
|
+
href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-file"
|
|
843
|
+
target="_blank"
|
|
844
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
845
|
+
></a>
|
|
846
|
+
<span class="property-type">file</span>
|
|
847
|
+
</dt>
|
|
848
|
+
<dd>
|
|
849
|
+
Absolute path to the file that's being translated, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
|
|
850
|
+
</dd>
|
|
851
|
+
<dt>
|
|
852
|
+
model
|
|
853
|
+
<a
|
|
854
|
+
href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-model"
|
|
855
|
+
target="_blank"
|
|
856
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
857
|
+
></a>
|
|
858
|
+
<span class="property-type"></span>
|
|
859
|
+
</dt>
|
|
860
|
+
<dd>ID of the model to use.</dd>
|
|
861
|
+
<dt class="optional">
|
|
862
|
+
prompt
|
|
863
|
+
<a
|
|
864
|
+
href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-prompt"
|
|
865
|
+
target="_blank"
|
|
866
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
867
|
+
></a>
|
|
868
|
+
<span class="property-type">string</span>
|
|
869
|
+
</dt>
|
|
870
|
+
<dd>
|
|
871
|
+
An optional text to guide the model's style or continue a previous audio
|
|
872
|
+
segment.
|
|
873
|
+
</dd>
|
|
874
|
+
<dt class="optional">
|
|
875
|
+
response_format
|
|
876
|
+
<a
|
|
877
|
+
href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-response_format"
|
|
878
|
+
target="_blank"
|
|
879
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
880
|
+
></a>
|
|
881
|
+
<span class="property-type">string</span>
|
|
882
|
+
</dt>
|
|
883
|
+
<dd>
|
|
884
|
+
The format of the transcript output, in one of these options: json,
|
|
885
|
+
text, srt, verbose_json, or vtt.
|
|
886
|
+
</dd>
|
|
887
|
+
<dt class="optional">
|
|
888
|
+
temperature
|
|
889
|
+
<a
|
|
890
|
+
href="https://platform.openai.com/docs/api-reference/audio/createTranslation#audio-createtranslation-temperature"
|
|
891
|
+
target="_blank"
|
|
892
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
893
|
+
></a>
|
|
894
|
+
<span class="property-type">number</span>
|
|
895
|
+
</dt>
|
|
896
|
+
<dd>The sampling temperature, between 0 and 1.</dd>
|
|
267
897
|
</dl>
|
|
268
|
-
|
|
898
|
+
</section>
|
|
269
899
|
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
<a
|
|
900
|
+
<section>
|
|
901
|
+
<h1 style="font-weight: bold;">🗨️ Chat</h1>
|
|
902
|
+
<a
|
|
903
|
+
href="https://platform.openai.com/docs/api-reference/chat"
|
|
904
|
+
target="_blank"
|
|
905
|
+
>Official Documentation
|
|
906
|
+
<i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
907
|
+
></a>
|
|
273
908
|
<h2>Create Chat Completion</h2>
|
|
274
|
-
<p>
|
|
909
|
+
<p>
|
|
910
|
+
Creates a model response for the given chat conversation.
|
|
911
|
+
<a
|
|
912
|
+
href="https://platform.openai.com/docs/api-reference/chat/create"
|
|
913
|
+
target="_blank"
|
|
914
|
+
>Full documentation.</a
|
|
915
|
+
>
|
|
916
|
+
</p>
|
|
275
917
|
<dl class="message-properties">
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
<
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
<
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
<
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
918
|
+
<h2>msg.payload Properties</h2>
|
|
919
|
+
|
|
920
|
+
<dt>
|
|
921
|
+
messages
|
|
922
|
+
<a
|
|
923
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-messages"
|
|
924
|
+
target="_blank"
|
|
925
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
926
|
+
></a>
|
|
927
|
+
<span class="property-type">array</span>
|
|
928
|
+
</dt>
|
|
929
|
+
<dd>A list of messages comprising the conversation so far.</dd>
|
|
930
|
+
<dt>
|
|
931
|
+
model
|
|
932
|
+
<a
|
|
933
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-model"
|
|
934
|
+
target="_blank"
|
|
935
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
936
|
+
></a>
|
|
937
|
+
<span class="property-type">string</span>
|
|
938
|
+
</dt>
|
|
939
|
+
<dd>ID of the model to use.</dd>
|
|
940
|
+
<dt class="optional">
|
|
941
|
+
frequency_penalty
|
|
942
|
+
<a
|
|
943
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-frequency_penalty"
|
|
944
|
+
target="_blank"
|
|
945
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
946
|
+
></a>
|
|
947
|
+
<span class="property-type">number</span>
|
|
948
|
+
</dt>
|
|
949
|
+
<dd>Number between -2.0 and 2.0.</dd>
|
|
950
|
+
<dt class="optional">
|
|
951
|
+
logit_bias
|
|
952
|
+
<a
|
|
953
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-logit_bias"
|
|
954
|
+
target="_blank"
|
|
955
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
956
|
+
></a>
|
|
957
|
+
<span class="property-type">object</span>
|
|
958
|
+
</dt>
|
|
959
|
+
<dd>
|
|
960
|
+
Modify the likelihood of specified tokens appearing in the completion.
|
|
961
|
+
</dd>
|
|
962
|
+
<dt class="optional">
|
|
963
|
+
logprobs
|
|
964
|
+
<a
|
|
965
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-logprobs"
|
|
966
|
+
target="_blank"
|
|
967
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
968
|
+
></a>
|
|
969
|
+
<span class="property-type">boolean</span>
|
|
970
|
+
</dt>
|
|
971
|
+
<dd>Whether to return log probabilities of the output tokens or not.</dd>
|
|
972
|
+
<dt class="optional">
|
|
973
|
+
top_logprobs
|
|
974
|
+
<a
|
|
975
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-top_logprobs"
|
|
976
|
+
target="_blank"
|
|
977
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
978
|
+
></a>
|
|
979
|
+
<span class="property-type">integer</span>
|
|
980
|
+
</dt>
|
|
981
|
+
<dd>
|
|
982
|
+
An integer between 0 and 5 specifying the number of most likely tokens
|
|
983
|
+
to return at each token position, each with an associated log
|
|
984
|
+
probability.
|
|
985
|
+
</dd>
|
|
986
|
+
<dt class="optional">
|
|
987
|
+
max_tokens
|
|
988
|
+
<a
|
|
989
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-max_tokens"
|
|
990
|
+
target="_blank"
|
|
991
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
992
|
+
></a>
|
|
993
|
+
<span class="property-type">integer</span>
|
|
994
|
+
</dt>
|
|
995
|
+
<dd>
|
|
996
|
+
The maximum number of tokens that can be generated in the chat
|
|
997
|
+
completion.
|
|
998
|
+
</dd>
|
|
999
|
+
<dt class="optional">
|
|
1000
|
+
n
|
|
1001
|
+
<a
|
|
1002
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-n"
|
|
1003
|
+
target="_blank"
|
|
1004
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1005
|
+
></a>
|
|
1006
|
+
<span class="property-type">integer</span>
|
|
1007
|
+
</dt>
|
|
1008
|
+
<dd>
|
|
1009
|
+
How many chat completion choices to generate for each input message.
|
|
1010
|
+
</dd>
|
|
1011
|
+
<dt class="optional">
|
|
1012
|
+
presence_penalty
|
|
1013
|
+
<a
|
|
1014
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-presence_penalty"
|
|
1015
|
+
target="_blank"
|
|
1016
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1017
|
+
></a>
|
|
1018
|
+
<span class="property-type">number</span>
|
|
1019
|
+
</dt>
|
|
1020
|
+
<dd>Number between -2.0 and 2.0.</dd>
|
|
1021
|
+
<dt class="optional">
|
|
1022
|
+
response_format
|
|
1023
|
+
<a
|
|
1024
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-response_format"
|
|
1025
|
+
target="_blank"
|
|
1026
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1027
|
+
></a>
|
|
1028
|
+
<span class="property-type">object</span>
|
|
1029
|
+
</dt>
|
|
1030
|
+
<dd>An object specifying the format that the model must output.</dd>
|
|
1031
|
+
<dt class="optional">
|
|
1032
|
+
seed
|
|
1033
|
+
<a
|
|
1034
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-seed"
|
|
1035
|
+
target="_blank"
|
|
1036
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1037
|
+
></a>
|
|
1038
|
+
<span class="property-type">integer</span>
|
|
1039
|
+
</dt>
|
|
1040
|
+
<dd>
|
|
1041
|
+
This feature is in Beta. If specified, the system will make a best
|
|
1042
|
+
effort to sample deterministically, such that repeated requests with the
|
|
1043
|
+
same seed and parameters should return the same result.
|
|
1044
|
+
</dd>
|
|
1045
|
+
<dt class="optional">
|
|
1046
|
+
stop
|
|
1047
|
+
<a
|
|
1048
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-stop"
|
|
1049
|
+
target="_blank"
|
|
1050
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1051
|
+
></a>
|
|
1052
|
+
<span class="property-type">string | array</span>
|
|
1053
|
+
</dt>
|
|
1054
|
+
<dd>
|
|
1055
|
+
Up to 4 sequences where the API will stop generating further tokens.
|
|
1056
|
+
</dd>
|
|
1057
|
+
<dt class="optional">
|
|
1058
|
+
stream
|
|
1059
|
+
<a
|
|
1060
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-stream"
|
|
1061
|
+
target="_blank"
|
|
1062
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1063
|
+
></a>
|
|
1064
|
+
<span class="property-type">boolean</span>
|
|
1065
|
+
</dt>
|
|
1066
|
+
<dd>If set, partial message deltas will be sent, like in ChatGPT.</dd>
|
|
1067
|
+
<dt class="optional">
|
|
1068
|
+
temperature
|
|
1069
|
+
<a
|
|
1070
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-temperature"
|
|
1071
|
+
target="_blank"
|
|
1072
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1073
|
+
></a>
|
|
1074
|
+
<span class="property-type">number</span>
|
|
1075
|
+
</dt>
|
|
1076
|
+
<dd>What sampling temperature to use, between 0 and 2.</dd>
|
|
1077
|
+
<dt class="optional">
|
|
1078
|
+
top_p
|
|
1079
|
+
<a
|
|
1080
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-top_p"
|
|
1081
|
+
target="_blank"
|
|
1082
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1083
|
+
></a>
|
|
1084
|
+
<span class="property-type">number</span>
|
|
1085
|
+
</dt>
|
|
1086
|
+
<dd>
|
|
1087
|
+
An alternative to sampling with temperature, called nucleus sampling,
|
|
1088
|
+
where the model considers the results of the tokens with top_p
|
|
1089
|
+
probability mass.
|
|
1090
|
+
</dd>
|
|
1091
|
+
<dt class="optional">
|
|
1092
|
+
tools
|
|
1093
|
+
<a
|
|
1094
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-tools"
|
|
1095
|
+
target="_blank"
|
|
1096
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1097
|
+
></a>
|
|
1098
|
+
<span class="property-type">array</span>
|
|
1099
|
+
</dt>
|
|
1100
|
+
<dd>A list of tools the model may call.</dd>
|
|
1101
|
+
<dt class="optional">
|
|
1102
|
+
tool_choice
|
|
1103
|
+
<a
|
|
1104
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-tool_choice"
|
|
1105
|
+
target="_blank"
|
|
1106
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1107
|
+
></a>
|
|
1108
|
+
<span class="property-type">string | object</span>
|
|
1109
|
+
</dt>
|
|
1110
|
+
<dd>Controls which (if any) function is called by the model.</dd>
|
|
1111
|
+
<dt class="optional">
|
|
1112
|
+
user
|
|
1113
|
+
<a
|
|
1114
|
+
href="https://platform.openai.com/docs/api-reference/chat/create#chat-create-user"
|
|
1115
|
+
target="_blank"
|
|
1116
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1117
|
+
></a>
|
|
1118
|
+
<span class="property-type">string</span>
|
|
1119
|
+
</dt>
|
|
1120
|
+
<dd>
|
|
1121
|
+
A unique identifier representing your end-user, which can help OpenAI to
|
|
1122
|
+
monitor and detect abuse.
|
|
1123
|
+
</dd>
|
|
294
1124
|
</dl>
|
|
295
|
-
|
|
1125
|
+
</section>
|
|
296
1126
|
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
<a
|
|
1127
|
+
<section>
|
|
1128
|
+
<h1 style="font-weight: bold;">🔗 Embeddings</h1>
|
|
1129
|
+
<a
|
|
1130
|
+
href="https://platform.openai.com/docs/api-reference/embeddings"
|
|
1131
|
+
target="_blank"
|
|
1132
|
+
>Official Documentation
|
|
1133
|
+
<i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1134
|
+
></a>
|
|
300
1135
|
<h2>Create Embeddings</h2>
|
|
301
1136
|
<p>Creates an embedding vector representing the input text.</p>
|
|
302
1137
|
<dl class="message-properties">
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
<
|
|
308
|
-
|
|
1138
|
+
<h2>msg.payload Properties</h2>
|
|
1139
|
+
|
|
1140
|
+
<dt>
|
|
1141
|
+
input
|
|
1142
|
+
<a
|
|
1143
|
+
href="https://platform.openai.com/docs/api-reference/embeddings/create#embeddings-create-input"
|
|
1144
|
+
target="_blank"
|
|
1145
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1146
|
+
></a>
|
|
1147
|
+
<span class="property-type">string | array</span>
|
|
1148
|
+
</dt>
|
|
1149
|
+
<dd>Input text to embed, encoded as a string or array of tokens.</dd>
|
|
1150
|
+
<dt>
|
|
1151
|
+
model
|
|
1152
|
+
<a
|
|
1153
|
+
href="https://platform.openai.com/docs/api-reference/embeddings/create#embeddings-create-model"
|
|
1154
|
+
target="_blank"
|
|
1155
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1156
|
+
></a>
|
|
1157
|
+
<span class="property-type">string</span>
|
|
1158
|
+
</dt>
|
|
1159
|
+
<dd>ID of the model to use.</dd>
|
|
1160
|
+
<dt class="optional">
|
|
1161
|
+
encoding_format
|
|
1162
|
+
<a
|
|
1163
|
+
href="https://platform.openai.com/docs/api-reference/embeddings/create#embeddings-create-encoding_format"
|
|
1164
|
+
target="_blank"
|
|
1165
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1166
|
+
></a>
|
|
1167
|
+
<span class="property-type">string</span>
|
|
1168
|
+
</dt>
|
|
1169
|
+
<dd>
|
|
1170
|
+
The format to return the embeddings in. Can be either float or base64.
|
|
1171
|
+
</dd>
|
|
1172
|
+
<dt class="optional">
|
|
1173
|
+
dimensions
|
|
1174
|
+
<a
|
|
1175
|
+
href="https://platform.openai.com/docs/api-reference/embeddings/create#embeddings-create-dimensions"
|
|
1176
|
+
target="_blank"
|
|
1177
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1178
|
+
></a>
|
|
1179
|
+
<span class="property-type">integer</span>
|
|
1180
|
+
</dt>
|
|
1181
|
+
<dd>
|
|
1182
|
+
The number of dimensions the resulting output embeddings should have.
|
|
1183
|
+
Only supported in text-embedding-3 and later models.
|
|
1184
|
+
</dd>
|
|
1185
|
+
<dt class="optional">
|
|
1186
|
+
user
|
|
1187
|
+
<a
|
|
1188
|
+
href="https://platform.openai.com/docs/api-reference/embeddings/create#embeddings-create-user"
|
|
1189
|
+
target="_blank"
|
|
1190
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1191
|
+
></a>
|
|
1192
|
+
<span class="property-type">string</span>
|
|
1193
|
+
</dt>
|
|
1194
|
+
<dd>
|
|
1195
|
+
A unique identifier representing your end-user, which can help OpenAI to
|
|
1196
|
+
monitor and detect abuse.
|
|
1197
|
+
</dd>
|
|
309
1198
|
</dl>
|
|
310
|
-
|
|
1199
|
+
</section>
|
|
311
1200
|
|
|
312
|
-
|
|
313
|
-
<h1 style="font-weight: bold;"
|
|
314
|
-
<a
|
|
315
|
-
|
|
316
|
-
|
|
1201
|
+
<section>
|
|
1202
|
+
<h1 style="font-weight: bold;">📁 Files</h1>
|
|
1203
|
+
<a
|
|
1204
|
+
href="https://platform.openai.com/docs/api-reference/files"
|
|
1205
|
+
target="_blank"
|
|
1206
|
+
>Official Documentation
|
|
1207
|
+
<i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1208
|
+
></a>
|
|
1209
|
+
<h2>List Files</h2>
|
|
1210
|
+
<p>Returns a list of files that belong to the user's organization.</p>
|
|
317
1211
|
<dl class="message-properties">
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
<
|
|
323
|
-
|
|
324
|
-
|
|
1212
|
+
<h2>msg.payload Properties</h2>
|
|
1213
|
+
|
|
1214
|
+
<dt class="optional">
|
|
1215
|
+
purpose
|
|
1216
|
+
<a
|
|
1217
|
+
href="https://platform.openai.com/docs/api-reference/files/list#files-list-purpose"
|
|
1218
|
+
target="_blank"
|
|
1219
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1220
|
+
></a>
|
|
1221
|
+
<span class="property-type">string</span>
|
|
1222
|
+
</dt>
|
|
1223
|
+
<dd>Only return files with the given purpose.</dd>
|
|
325
1224
|
</dl>
|
|
326
1225
|
|
|
327
|
-
<h2>
|
|
328
|
-
<p>List your organization's fine-tuning jobs</p>
|
|
1226
|
+
<h2>Upload File</h2>
|
|
329
1227
|
<dl class="message-properties">
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
1228
|
+
<h2>msg.payload Properties</h2>
|
|
1229
|
+
|
|
1230
|
+
<dt>
|
|
1231
|
+
file
|
|
1232
|
+
<a
|
|
1233
|
+
href="https://platform.openai.com/docs/api-reference/files/create#files-create-file"
|
|
1234
|
+
target="_blank"
|
|
1235
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1236
|
+
></a>
|
|
1237
|
+
<span class="property-type">file</span>
|
|
1238
|
+
</dt>
|
|
1239
|
+
<dd>Absolute path to the file that's being uploaded.</dd>
|
|
1240
|
+
<dt>
|
|
1241
|
+
purpose
|
|
1242
|
+
<a
|
|
1243
|
+
href="https://platform.openai.com/docs/api-reference/files/create#files-create-purpose"
|
|
1244
|
+
target="_blank"
|
|
1245
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1246
|
+
></a>
|
|
1247
|
+
<span class="property-type">string</span>
|
|
1248
|
+
</dt>
|
|
1249
|
+
<dd>The intended purpose of the uploaded file.</dd>
|
|
334
1250
|
</dl>
|
|
335
1251
|
|
|
336
|
-
<h2>
|
|
337
|
-
<p>
|
|
1252
|
+
<h2>Delete File</h2>
|
|
1253
|
+
<p>Delete a file.</p>
|
|
338
1254
|
<dl class="message-properties">
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
1255
|
+
<h2>msg.payload Properties</h2>
|
|
1256
|
+
|
|
1257
|
+
<dt>file_id <span class="property-type">string</span></dt>
|
|
1258
|
+
<dd>The ID of the file to use for this request.</dd>
|
|
342
1259
|
</dl>
|
|
343
1260
|
|
|
344
|
-
<h2>
|
|
345
|
-
<p>
|
|
1261
|
+
<h2>Retrieve File</h2>
|
|
1262
|
+
<p>Returns information about a specific file.</p>
|
|
346
1263
|
<dl class="message-properties">
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
<
|
|
1264
|
+
<h2>msg.payload Properties</h2>
|
|
1265
|
+
|
|
1266
|
+
<dt>
|
|
1267
|
+
file_id
|
|
1268
|
+
<a
|
|
1269
|
+
href="https://platform.openai.com/docs/api-reference/files/delete#files-delete-file_id"
|
|
1270
|
+
target="_blank"
|
|
1271
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1272
|
+
></a>
|
|
1273
|
+
<span class="property-type">string</span>
|
|
1274
|
+
</dt>
|
|
1275
|
+
<dd>The ID of the file to use for this request.</dd>
|
|
352
1276
|
</dl>
|
|
353
1277
|
|
|
354
|
-
<h2>
|
|
355
|
-
<p>
|
|
1278
|
+
<h2>Retrieve File Content</h2>
|
|
1279
|
+
<p>Returns the contents of the specified file.</p>
|
|
356
1280
|
<dl class="message-properties">
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
1281
|
+
<h2>msg.payload Properties</h2>
|
|
1282
|
+
|
|
1283
|
+
<dt>
|
|
1284
|
+
file_id
|
|
1285
|
+
<a
|
|
1286
|
+
href="https://platform.openai.com/docs/api-reference/files/retrieve-contents#files-retrieve-contents-file_id"
|
|
1287
|
+
target="_blank"
|
|
1288
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1289
|
+
></a>
|
|
1290
|
+
<span class="property-type">string</span>
|
|
1291
|
+
</dt>
|
|
1292
|
+
<dd>The ID of the file to use for this request.</dd>
|
|
360
1293
|
</dl>
|
|
361
|
-
|
|
1294
|
+
</section>
|
|
362
1295
|
|
|
363
|
-
|
|
364
|
-
<h1 style="font-weight: bold;"
|
|
365
|
-
<a
|
|
366
|
-
|
|
367
|
-
|
|
1296
|
+
<section>
|
|
1297
|
+
<h1 style="font-weight: bold;">🔧 Fine-tuning</h1>
|
|
1298
|
+
<a
|
|
1299
|
+
href="https://platform.openai.com/docs/api-reference/fine-tuning"
|
|
1300
|
+
target="_blank"
|
|
1301
|
+
>Official Documentation
|
|
1302
|
+
<i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1303
|
+
></a>
|
|
1304
|
+
<h2>Create Fine-tuning Job</h2>
|
|
1305
|
+
<p>
|
|
1306
|
+
Creates a job that fine-tunes a specified model from a given dataset.
|
|
1307
|
+
Response includes details of the enqueued job including job status and the
|
|
1308
|
+
name of the fine-tuned models once complete.
|
|
1309
|
+
</p>
|
|
368
1310
|
<dl class="message-properties">
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
1311
|
+
<h2>msg.payload Properties</h2>
|
|
1312
|
+
|
|
1313
|
+
<dt>
|
|
1314
|
+
model
|
|
1315
|
+
<a
|
|
1316
|
+
href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-model"
|
|
1317
|
+
target="_blank"
|
|
1318
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1319
|
+
></a>
|
|
1320
|
+
<span class="property-type">string</span>
|
|
1321
|
+
</dt>
|
|
1322
|
+
<dd>The name of the model to fine-tune.</dd>
|
|
1323
|
+
<dt>
|
|
1324
|
+
training_file
|
|
1325
|
+
<a
|
|
1326
|
+
href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-training_file"
|
|
1327
|
+
target="_blank"
|
|
1328
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1329
|
+
></a>
|
|
1330
|
+
<span class="property-type">string</span>
|
|
1331
|
+
</dt>
|
|
1332
|
+
<dd>The ID of an uploaded file that contains training data.</dd>
|
|
1333
|
+
<dt class="optional">
|
|
1334
|
+
hyperparameters
|
|
1335
|
+
<a
|
|
1336
|
+
href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-hyperparameters"
|
|
1337
|
+
target="_blank"
|
|
1338
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1339
|
+
></a>
|
|
1340
|
+
<span class="property-type">object</span>
|
|
1341
|
+
</dt>
|
|
1342
|
+
<dd>The hyperparameters used for the fine-tuning job.</dd>
|
|
1343
|
+
<dt class="optional">
|
|
1344
|
+
suffix
|
|
1345
|
+
<a
|
|
1346
|
+
href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-suffix"
|
|
1347
|
+
target="_blank"
|
|
1348
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1349
|
+
></a>
|
|
1350
|
+
<span class="property-type">string</span>
|
|
1351
|
+
</dt>
|
|
1352
|
+
<dd>
|
|
1353
|
+
A string of up to 18 characters that will be added to your fine-tuned
|
|
1354
|
+
model name.
|
|
1355
|
+
</dd>
|
|
1356
|
+
<dt class="optional">
|
|
1357
|
+
validation_file
|
|
1358
|
+
<a
|
|
1359
|
+
href="https://platform.openai.com/docs/api-reference/fine-tuning/create#fine-tuning-create-validation_file"
|
|
1360
|
+
target="_blank"
|
|
1361
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1362
|
+
></a>
|
|
1363
|
+
<span class="property-type">string</span>
|
|
1364
|
+
</dt>
|
|
1365
|
+
<dd>The ID of an uploaded file that contains validation data.</dd>
|
|
372
1366
|
</dl>
|
|
373
1367
|
|
|
374
|
-
<h2>
|
|
1368
|
+
<h2>List Fine-tuning Jobs</h2>
|
|
1369
|
+
<p>List your organization's fine-tuning jobs</p>
|
|
375
1370
|
<dl class="message-properties">
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
<
|
|
1371
|
+
<h2>msg.payload Properties</h2>
|
|
1372
|
+
|
|
1373
|
+
<dt class="optional">
|
|
1374
|
+
after
|
|
1375
|
+
<a
|
|
1376
|
+
href="https://platform.openai.com/docs/api-reference/fine-tuning/list#fine-tuning-list-after"
|
|
1377
|
+
target="_blank"
|
|
1378
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1379
|
+
></a>
|
|
1380
|
+
<span class="property-type">string</span>
|
|
1381
|
+
</dt>
|
|
1382
|
+
<dd>Identifier for the last job from the previous pagination request.</dd>
|
|
1383
|
+
<dt class="optional">
|
|
1384
|
+
limit
|
|
1385
|
+
<a
|
|
1386
|
+
href="https://platform.openai.com/docs/api-reference/fine-tuning/list#fine-tuning-list-limit"
|
|
1387
|
+
target="_blank"
|
|
1388
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1389
|
+
></a>
|
|
1390
|
+
<span class="property-type">integer</span>
|
|
1391
|
+
</dt>
|
|
1392
|
+
<dd>Number of fine-tuning jobs to retrieve.</dd>
|
|
381
1393
|
</dl>
|
|
382
1394
|
|
|
383
|
-
<h2>
|
|
384
|
-
<p>
|
|
1395
|
+
<h2>Retrieve Fine-tuning Job</h2>
|
|
1396
|
+
<p>Get info about a fine-tuning job.</p>
|
|
385
1397
|
<dl class="message-properties">
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
1398
|
+
<h2>msg.payload Properties</h2>
|
|
1399
|
+
|
|
1400
|
+
<dt>
|
|
1401
|
+
fine_tuning_job_id
|
|
1402
|
+
<a
|
|
1403
|
+
href="https://platform.openai.com/docs/api-reference/fine-tuning/retrieve#fine-tuning-retrieve-fine_tuning_job_id"
|
|
1404
|
+
target="_blank"
|
|
1405
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1406
|
+
></a>
|
|
1407
|
+
<span class="property-type">string</span>
|
|
1408
|
+
</dt>
|
|
1409
|
+
<dd>The ID of the fine-tuning job.</dd>
|
|
389
1410
|
</dl>
|
|
390
1411
|
|
|
391
|
-
<h2>
|
|
392
|
-
<p>
|
|
1412
|
+
<h2>List Fine-tuning Events</h2>
|
|
1413
|
+
<p>Get status updates for a fine-tuning job.</p>
|
|
393
1414
|
<dl class="message-properties">
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
1415
|
+
<h2>msg.payload Properties</h2>
|
|
1416
|
+
|
|
1417
|
+
<dt>
|
|
1418
|
+
fine_tuning_job_id
|
|
1419
|
+
<a
|
|
1420
|
+
href="https://platform.openai.com/docs/api-reference/fine-tuning/list-events#fine-tuning-list-events-fine_tuning_job_id"
|
|
1421
|
+
target="_blank"
|
|
1422
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1423
|
+
></a>
|
|
1424
|
+
<span class="property-type">string</span>
|
|
1425
|
+
</dt>
|
|
1426
|
+
<dd>The ID of the fine-tuning job to get events for.</dd>
|
|
1427
|
+
<dt class="optional">
|
|
1428
|
+
after
|
|
1429
|
+
<a
|
|
1430
|
+
href="https://platform.openai.com/docs/api-reference/fine-tuning/list-events#fine-tuning-list-events-after"
|
|
1431
|
+
target="_blank"
|
|
1432
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1433
|
+
></a>
|
|
1434
|
+
<span class="property-type">string</span>
|
|
1435
|
+
</dt>
|
|
1436
|
+
<dd>
|
|
1437
|
+
Identifier for the last event from the previous pagination request.
|
|
1438
|
+
</dd>
|
|
1439
|
+
<dt class="optional">
|
|
1440
|
+
limit
|
|
1441
|
+
<a
|
|
1442
|
+
href="https://platform.openai.com/docs/api-reference/fine-tuning/list-events#fine-tuning-list-events-limit"
|
|
1443
|
+
target="_blank"
|
|
1444
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1445
|
+
></a>
|
|
1446
|
+
<span class="property-type">integer</span>
|
|
1447
|
+
</dt>
|
|
1448
|
+
<dd>Number of events to retrieve.</dd>
|
|
397
1449
|
</dl>
|
|
398
1450
|
|
|
399
|
-
<h2>
|
|
400
|
-
<p>
|
|
1451
|
+
<h2>Cancel Fine-tuning Job</h2>
|
|
1452
|
+
<p>Immediately cancel a fine-tune job.</p>
|
|
401
1453
|
<dl class="message-properties">
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
1454
|
+
<h2>msg.payload Properties</h2>
|
|
1455
|
+
|
|
1456
|
+
<dt>
|
|
1457
|
+
fine_tuning_job_id
|
|
1458
|
+
<a
|
|
1459
|
+
href="https://platform.openai.com/docs/api-reference/fine-tuning/cancel#fine-tuning-cancel-fine_tuning_job_id"
|
|
1460
|
+
target="_blank"
|
|
1461
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1462
|
+
></a>
|
|
1463
|
+
<span class="property-type">string</span>
|
|
1464
|
+
</dt>
|
|
1465
|
+
<dd>The ID of the fine-tuning job to cancel.</dd>
|
|
405
1466
|
</dl>
|
|
406
|
-
|
|
1467
|
+
</section>
|
|
407
1468
|
|
|
408
|
-
|
|
1469
|
+
<section>
|
|
409
1470
|
<h1 style="font-weight: bold;">🖼️ Images</h1>
|
|
410
|
-
<a
|
|
1471
|
+
<a
|
|
1472
|
+
href="https://platform.openai.com/docs/api-reference/images"
|
|
1473
|
+
target="_blank"
|
|
1474
|
+
>Official Documentation
|
|
1475
|
+
<i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1476
|
+
></a>
|
|
411
1477
|
<h2>Create Image</h2>
|
|
412
1478
|
<p>Creates an image given a prompt.</p>
|
|
413
1479
|
<dl class="message-properties">
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
<
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
<
|
|
1480
|
+
<h2>msg.payload Properties</h2>
|
|
1481
|
+
|
|
1482
|
+
<dt>
|
|
1483
|
+
prompt
|
|
1484
|
+
<a
|
|
1485
|
+
href="https://platform.openai.com/docs/api-reference/images/create#images-create-prompt"
|
|
1486
|
+
target="_blank"
|
|
1487
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1488
|
+
></a>
|
|
1489
|
+
<span class="property-type">string</span>
|
|
1490
|
+
</dt>
|
|
1491
|
+
<dd>A text description of the desired image(s).</dd>
|
|
1492
|
+
<dt class="optional">
|
|
1493
|
+
model
|
|
1494
|
+
<a
|
|
1495
|
+
href="https://platform.openai.com/docs/api-reference/images/create#images-create-model"
|
|
1496
|
+
target="_blank"
|
|
1497
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1498
|
+
></a>
|
|
1499
|
+
<span class="property-type">string</span>
|
|
1500
|
+
</dt>
|
|
1501
|
+
<dd>The model to use for image generation.</dd>
|
|
1502
|
+
<dt class="optional">
|
|
1503
|
+
n
|
|
1504
|
+
<a
|
|
1505
|
+
href="https://platform.openai.com/docs/api-reference/images/create#images-create-n"
|
|
1506
|
+
target="_blank"
|
|
1507
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1508
|
+
></a>
|
|
1509
|
+
<span class="property-type">integer</span>
|
|
1510
|
+
</dt>
|
|
1511
|
+
<dd>The number of images to generate.</dd>
|
|
1512
|
+
<dt class="optional">
|
|
1513
|
+
quality
|
|
1514
|
+
<a
|
|
1515
|
+
href="https://platform.openai.com/docs/api-reference/images/create#images-create-quality"
|
|
1516
|
+
target="_blank"
|
|
1517
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1518
|
+
></a>
|
|
1519
|
+
<span class="property-type">string</span>
|
|
1520
|
+
</dt>
|
|
1521
|
+
<dd>The quality of the image that will be generated.</dd>
|
|
1522
|
+
<dt class="optional">
|
|
1523
|
+
response_format
|
|
1524
|
+
<a
|
|
1525
|
+
href="https://platform.openai.com/docs/api-reference/images/create#images-create-response_format"
|
|
1526
|
+
target="_blank"
|
|
1527
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1528
|
+
></a>
|
|
1529
|
+
<span class="property-type">string</span>
|
|
1530
|
+
</dt>
|
|
1531
|
+
<dd>
|
|
1532
|
+
The format in which the generated images are returned. Must be one of
|
|
1533
|
+
url or b64_json.
|
|
1534
|
+
</dd>
|
|
1535
|
+
<dt class="optional">
|
|
1536
|
+
size
|
|
1537
|
+
<a
|
|
1538
|
+
href="https://platform.openai.com/docs/api-reference/images/create#images-create-size"
|
|
1539
|
+
target="_blank"
|
|
1540
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1541
|
+
></a>
|
|
1542
|
+
<span class="property-type">string</span>
|
|
1543
|
+
</dt>
|
|
1544
|
+
<dd>
|
|
1545
|
+
The size of the generated images. Must be one of 256x256, 512x512, or
|
|
1546
|
+
1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or
|
|
1547
|
+
1024x1792.
|
|
1548
|
+
</dd>
|
|
1549
|
+
<dt class="optional">
|
|
1550
|
+
style
|
|
1551
|
+
<a
|
|
1552
|
+
href="https://platform.openai.com/docs/api-reference/images/create#images-create-style"
|
|
1553
|
+
target="_blank"
|
|
1554
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1555
|
+
></a>
|
|
1556
|
+
<span class="property-type">string</span>
|
|
1557
|
+
</dt>
|
|
1558
|
+
<dd>
|
|
1559
|
+
The style of the generated images. Must be one of vivid or natural.
|
|
1560
|
+
</dd>
|
|
1561
|
+
<dt class="optional">
|
|
1562
|
+
user
|
|
1563
|
+
<a
|
|
1564
|
+
href="https://platform.openai.com/docs/api-reference/images/create#images-create-user"
|
|
1565
|
+
target="_blank"
|
|
1566
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1567
|
+
></a>
|
|
1568
|
+
<span class="property-type">string</span>
|
|
1569
|
+
</dt>
|
|
1570
|
+
<dd>
|
|
1571
|
+
A unique identifier representing your end-user, which can help OpenAI to
|
|
1572
|
+
monitor and detect abuse.
|
|
1573
|
+
</dd>
|
|
424
1574
|
</dl>
|
|
425
1575
|
|
|
426
1576
|
<h2>Create Image Edit</h2>
|
|
427
|
-
<p>
|
|
1577
|
+
<p>
|
|
1578
|
+
Creates an edited or extended image given an original image and a prompt.
|
|
1579
|
+
</p>
|
|
428
1580
|
<dl class="message-properties">
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
<
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
<
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
1581
|
+
<h2>msg.payload Properties</h2>
|
|
1582
|
+
|
|
1583
|
+
<dt>
|
|
1584
|
+
image
|
|
1585
|
+
<a
|
|
1586
|
+
href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-image"
|
|
1587
|
+
target="_blank"
|
|
1588
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1589
|
+
></a>
|
|
1590
|
+
<span class="property-type">string</span>
|
|
1591
|
+
</dt>
|
|
1592
|
+
<dd>The image to edit.</dd>
|
|
1593
|
+
<dt>
|
|
1594
|
+
prompt
|
|
1595
|
+
<a
|
|
1596
|
+
href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-prompt"
|
|
1597
|
+
target="_blank"
|
|
1598
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1599
|
+
></a>
|
|
1600
|
+
<span class="property-type">string</span>
|
|
1601
|
+
</dt>
|
|
1602
|
+
<dd>A text description of the desired image(s).</dd>
|
|
1603
|
+
<dt class="optional">
|
|
1604
|
+
mask
|
|
1605
|
+
<a
|
|
1606
|
+
href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-mask"
|
|
1607
|
+
target="_blank"
|
|
1608
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1609
|
+
></a>
|
|
1610
|
+
<span class="property-type">string</span>
|
|
1611
|
+
</dt>
|
|
1612
|
+
<dd>
|
|
1613
|
+
An additional image whose fully transparent areas (e.g. where alpha is
|
|
1614
|
+
zero) indicate where image should be edited.
|
|
1615
|
+
</dd>
|
|
1616
|
+
<dt class="optional">
|
|
1617
|
+
model
|
|
1618
|
+
<a
|
|
1619
|
+
href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-model"
|
|
1620
|
+
target="_blank"
|
|
1621
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1622
|
+
></a>
|
|
1623
|
+
<span class="property-type"></span>
|
|
1624
|
+
</dt>
|
|
1625
|
+
<dd>The model to use for image generation.</dd>
|
|
1626
|
+
<dt class="optional">
|
|
1627
|
+
n
|
|
1628
|
+
<a
|
|
1629
|
+
href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-n"
|
|
1630
|
+
target="_blank"
|
|
1631
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1632
|
+
></a>
|
|
1633
|
+
<span class="property-type">integer</span>
|
|
1634
|
+
</dt>
|
|
1635
|
+
<dd>The number of images to generate. Must be between 1 and 10.</dd>
|
|
1636
|
+
<dt class="optional">
|
|
1637
|
+
size
|
|
1638
|
+
<a
|
|
1639
|
+
href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-size"
|
|
1640
|
+
target="_blank"
|
|
1641
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1642
|
+
></a>
|
|
1643
|
+
<span class="property-type">string</span>
|
|
1644
|
+
</dt>
|
|
1645
|
+
<dd>The size of the generated images.</dd>
|
|
1646
|
+
<dt class="optional">
|
|
1647
|
+
response_format
|
|
1648
|
+
<a
|
|
1649
|
+
href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-response_format"
|
|
1650
|
+
target="_blank"
|
|
1651
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1652
|
+
></a>
|
|
1653
|
+
<span class="property-type">string</span>
|
|
1654
|
+
</dt>
|
|
1655
|
+
<dd>
|
|
1656
|
+
The format in which the generated images are returned. Must be one of
|
|
1657
|
+
url or b64_json.
|
|
1658
|
+
</dd>
|
|
1659
|
+
<dt class="optional">
|
|
1660
|
+
user
|
|
1661
|
+
<a
|
|
1662
|
+
href="https://platform.openai.com/docs/api-reference/images/createEdit#images-createedit-user"
|
|
1663
|
+
target="_blank"
|
|
1664
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1665
|
+
></a>
|
|
1666
|
+
<span class="property-type">string</span>
|
|
1667
|
+
</dt>
|
|
1668
|
+
<dd>
|
|
1669
|
+
A unique identifier representing your end-user, which can help OpenAI to
|
|
1670
|
+
monitor and detect abuse.
|
|
1671
|
+
</dd>
|
|
1672
|
+
</dl>
|
|
1673
|
+
|
|
442
1674
|
<h2>Create Image Variation</h2>
|
|
443
1675
|
<p>Creates a variation of a given image.</p>
|
|
444
1676
|
<dl class="message-properties">
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
<
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
1677
|
+
<h2>msg.payload Properties</h2>
|
|
1678
|
+
|
|
1679
|
+
<dt>
|
|
1680
|
+
image
|
|
1681
|
+
<a
|
|
1682
|
+
href="https://platform.openai.com/docs/api-reference/images/createVariation#images-createvariation-image"
|
|
1683
|
+
target="_blank"
|
|
1684
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1685
|
+
></a>
|
|
1686
|
+
<span class="property-type">string</span>
|
|
1687
|
+
</dt>
|
|
1688
|
+
<dd>The image to use as the basis for the variation(s).</dd>
|
|
1689
|
+
<dt>
|
|
1690
|
+
model
|
|
1691
|
+
<a
|
|
1692
|
+
href="https://platform.openai.com/docs/api-reference/images/createVariation#images-createvariation-model"
|
|
1693
|
+
target="_blank"
|
|
1694
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1695
|
+
></a>
|
|
1696
|
+
<span class="property-type"></span>
|
|
1697
|
+
</dt>
|
|
1698
|
+
<dd>The model to use for image generation.</dd>
|
|
1699
|
+
<dt>
|
|
1700
|
+
n
|
|
1701
|
+
<a
|
|
1702
|
+
href="https://platform.openai.com/docs/api-reference/images/createVariation#images-createvariation-n"
|
|
1703
|
+
target="_blank"
|
|
1704
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1705
|
+
></a>
|
|
1706
|
+
<span class="property-type">integer</span>
|
|
1707
|
+
</dt>
|
|
1708
|
+
<dd>The number of images to generate.</dd>
|
|
1709
|
+
<dt>
|
|
1710
|
+
response_format
|
|
1711
|
+
<a
|
|
1712
|
+
href="https://platform.openai.com/docs/api-reference/images/createVariation#images-createvariation-response_format"
|
|
1713
|
+
target="_blank"
|
|
1714
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1715
|
+
></a>
|
|
1716
|
+
<span class="property-type">string</span>
|
|
1717
|
+
</dt>
|
|
1718
|
+
<dd>The format in which the generated images are returned.</dd>
|
|
1719
|
+
<dt>
|
|
1720
|
+
size
|
|
1721
|
+
<a
|
|
1722
|
+
href="https://platform.openai.com/docs/api-reference/images/createVariation#images-createvariation-size"
|
|
1723
|
+
target="_blank"
|
|
1724
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1725
|
+
></a>
|
|
1726
|
+
<span class="property-type">string</span>
|
|
1727
|
+
</dt>
|
|
1728
|
+
<dd>The size of the generated images.</dd>
|
|
1729
|
+
<dt>
|
|
1730
|
+
user
|
|
1731
|
+
<a
|
|
1732
|
+
href="https://platform.openai.com/docs/api-reference/images/createVariation#images-createvariation-user"
|
|
1733
|
+
target="_blank"
|
|
1734
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1735
|
+
></a>
|
|
1736
|
+
<span class="property-type">string</span>
|
|
1737
|
+
</dt>
|
|
1738
|
+
<dd>
|
|
1739
|
+
A unique identifier representing your end-user, which can help OpenAI to
|
|
1740
|
+
monitor and detect abuse.
|
|
1741
|
+
</dd>
|
|
454
1742
|
</dl>
|
|
455
|
-
|
|
1743
|
+
</section>
|
|
456
1744
|
|
|
457
|
-
|
|
1745
|
+
<section>
|
|
458
1746
|
<h1 style="font-weight: bold;">📟 Messages</h1>
|
|
459
|
-
<a
|
|
1747
|
+
<a
|
|
1748
|
+
href="https://platform.openai.com/docs/api-reference/messages"
|
|
1749
|
+
target="_blank"
|
|
1750
|
+
>Official Documentation
|
|
1751
|
+
<i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1752
|
+
></a>
|
|
460
1753
|
<h2>List Messages</h2>
|
|
461
1754
|
<p>Returns a list of messages for a given thread.</p>
|
|
462
1755
|
<dl class="message-properties">
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
<
|
|
468
|
-
|
|
469
|
-
|
|
1756
|
+
<h2>msg.payload Properties</h2>
|
|
1757
|
+
|
|
1758
|
+
<dt>
|
|
1759
|
+
thread_id
|
|
1760
|
+
<a
|
|
1761
|
+
href="https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-thread_id"
|
|
1762
|
+
target="_blank"
|
|
1763
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1764
|
+
></a>
|
|
1765
|
+
<span class="property-type">string</span>
|
|
1766
|
+
</dt>
|
|
1767
|
+
<dd>The ID of the thread the messages belong to.</dd>
|
|
1768
|
+
<dt class="optional">
|
|
1769
|
+
limit
|
|
1770
|
+
<a
|
|
1771
|
+
href="https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-limit"
|
|
1772
|
+
target="_blank"
|
|
1773
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1774
|
+
></a>
|
|
1775
|
+
<span class="property-type">integer</span>
|
|
1776
|
+
</dt>
|
|
1777
|
+
<dd>
|
|
1778
|
+
A limit on the number of objects to be returned. Limit can range between
|
|
1779
|
+
1 and 100, and the default is 20.
|
|
1780
|
+
</dd>
|
|
1781
|
+
<dt class="optional">
|
|
1782
|
+
order
|
|
1783
|
+
<a
|
|
1784
|
+
href="https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-order"
|
|
1785
|
+
target="_blank"
|
|
1786
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1787
|
+
></a>
|
|
1788
|
+
<span class="property-type">string</span>
|
|
1789
|
+
</dt>
|
|
1790
|
+
<dd>Sort order by the created_at timestamp of the objects.</dd>
|
|
1791
|
+
<dt class="optional">
|
|
1792
|
+
after
|
|
1793
|
+
<a
|
|
1794
|
+
href="https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-after"
|
|
1795
|
+
target="_blank"
|
|
1796
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1797
|
+
></a>
|
|
1798
|
+
<span class="property-type">string</span>
|
|
1799
|
+
</dt>
|
|
1800
|
+
<dd>A cursor for use in pagination.</dd>
|
|
1801
|
+
<dt class="optional">
|
|
1802
|
+
before
|
|
1803
|
+
<a
|
|
1804
|
+
href="https://platform.openai.com/docs/api-reference/messages/listMessages#messages-listmessages-before"
|
|
1805
|
+
target="_blank"
|
|
1806
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1807
|
+
></a>
|
|
1808
|
+
<span class="property-type">string</span>
|
|
1809
|
+
</dt>
|
|
1810
|
+
<dd>A cursor for use in pagination.</dd>
|
|
470
1811
|
</dl>
|
|
471
1812
|
|
|
472
1813
|
<h3>Create Message</h3>
|
|
473
1814
|
<p>Create a message.</p>
|
|
474
1815
|
<dl class="message-properties">
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
<
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
1816
|
+
<h2>msg.payload Properties</h2>
|
|
1817
|
+
|
|
1818
|
+
<dt>
|
|
1819
|
+
thread_id
|
|
1820
|
+
<a
|
|
1821
|
+
href="https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-thread_id"
|
|
1822
|
+
target="_blank"
|
|
1823
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1824
|
+
></a>
|
|
1825
|
+
<span class="property-type">string</span>
|
|
1826
|
+
</dt>
|
|
1827
|
+
<dd>The ID of the thread to create a message for.</dd>
|
|
1828
|
+
<dt>
|
|
1829
|
+
role
|
|
1830
|
+
<a
|
|
1831
|
+
href="https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-role"
|
|
1832
|
+
target="_blank"
|
|
1833
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1834
|
+
></a>
|
|
1835
|
+
<span class="property-type">string</span>
|
|
1836
|
+
</dt>
|
|
1837
|
+
<dd>The role of the entity that is creating the message.</dd>
|
|
1838
|
+
<dt>
|
|
1839
|
+
content
|
|
1840
|
+
<a
|
|
1841
|
+
href="https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-content"
|
|
1842
|
+
target="_blank"
|
|
1843
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1844
|
+
></a>
|
|
1845
|
+
<span class="property-type">string</span>
|
|
1846
|
+
</dt>
|
|
1847
|
+
<dd>The content of the message.</dd>
|
|
1848
|
+
<dt class="optional">
|
|
1849
|
+
file_ids
|
|
1850
|
+
<a
|
|
1851
|
+
href="https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-file_ids"
|
|
1852
|
+
target="_blank"
|
|
1853
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1854
|
+
></a>
|
|
1855
|
+
<span class="property-type">array</span>
|
|
1856
|
+
</dt>
|
|
1857
|
+
<dd>A list of File IDs that the message should use.</dd>
|
|
1858
|
+
<dt class="optional">
|
|
1859
|
+
metadata
|
|
1860
|
+
<a
|
|
1861
|
+
href="https://platform.openai.com/docs/api-reference/messages/createMessage#messages-createmessage-metadata"
|
|
1862
|
+
target="_blank"
|
|
1863
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1864
|
+
></a>
|
|
1865
|
+
<span class="property-type">object</span>
|
|
1866
|
+
</dt>
|
|
1867
|
+
<dd>Set of 16 key-value pairs that can be attached to an object.</dd>
|
|
483
1868
|
</dl>
|
|
484
1869
|
|
|
485
1870
|
<h3>Retrieve Message</h3>
|
|
486
1871
|
<p>Retrieve a message.</p>
|
|
487
1872
|
<dl class="message-properties">
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
1873
|
+
<h2>msg.payload Properties</h2>
|
|
1874
|
+
|
|
1875
|
+
<dt>
|
|
1876
|
+
thread_id
|
|
1877
|
+
<a
|
|
1878
|
+
href="https://platform.openai.com/docs/api-reference/messages/getMessage#messages-getmessage-thread_id"
|
|
1879
|
+
target="_blank"
|
|
1880
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1881
|
+
></a>
|
|
1882
|
+
<span class="property-type">string</span>
|
|
1883
|
+
</dt>
|
|
1884
|
+
<dd>The ID of the thread to which this message belongs.</dd>
|
|
1885
|
+
<dt>
|
|
1886
|
+
message_id
|
|
1887
|
+
<a
|
|
1888
|
+
href="https://platform.openai.com/docs/api-reference/messages/getMessage#messages-getmessage-message_id"
|
|
1889
|
+
target="_blank"
|
|
1890
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1891
|
+
></a>
|
|
1892
|
+
<span class="property-type">string</span>
|
|
1893
|
+
</dt>
|
|
1894
|
+
<dd>The ID of the message to retrieve.</dd>
|
|
492
1895
|
</dl>
|
|
493
1896
|
|
|
494
1897
|
<h3>Modify Message</h3>
|
|
495
1898
|
<p>Modifies a message.</p>
|
|
496
1899
|
<dl class="message-properties">
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
1900
|
+
<h2>msg.payload Properties</h2>
|
|
1901
|
+
|
|
1902
|
+
<dt>
|
|
1903
|
+
thread_id
|
|
1904
|
+
<a
|
|
1905
|
+
href="https://platform.openai.com/docs/api-reference/messages/modifyMessage#messages-modifymessage-thread_id"
|
|
1906
|
+
target="_blank"
|
|
1907
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1908
|
+
></a>
|
|
1909
|
+
<span class="property-type">string</span>
|
|
1910
|
+
</dt>
|
|
1911
|
+
<dd>The ID of the thread to which this message belongs.</dd>
|
|
1912
|
+
<dt>
|
|
1913
|
+
message_id
|
|
1914
|
+
<a
|
|
1915
|
+
href="https://platform.openai.com/docs/api-reference/messages/modifyMessage#messages-modifymessage-message_id"
|
|
1916
|
+
target="_blank"
|
|
1917
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1918
|
+
></a>
|
|
1919
|
+
<span class="property-type">string</span>
|
|
1920
|
+
</dt>
|
|
1921
|
+
<dd>The ID of the message to modify.</dd>
|
|
1922
|
+
<dt class="optional">
|
|
1923
|
+
metadata
|
|
1924
|
+
<a
|
|
1925
|
+
href="https://platform.openai.com/docs/api-reference/messages/modifyMessage#messages-modifymessage-metadata"
|
|
1926
|
+
target="_blank"
|
|
1927
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1928
|
+
></a>
|
|
1929
|
+
<span class="property-type">object</span>
|
|
1930
|
+
</dt>
|
|
1931
|
+
<dd>Set of 16 key-value pairs that can be attached to an object.</dd>
|
|
503
1932
|
</dl>
|
|
504
1933
|
|
|
505
1934
|
<h3>List Message Files</h3>
|
|
506
1935
|
<p>Returns a list of message files.</p>
|
|
507
1936
|
<dl class="message-properties">
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
<
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
1937
|
+
<h2>msg.payload Properties</h2>
|
|
1938
|
+
|
|
1939
|
+
<dt>
|
|
1940
|
+
thread_id
|
|
1941
|
+
<a
|
|
1942
|
+
href="https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-thread_id"
|
|
1943
|
+
target="_blank"
|
|
1944
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1945
|
+
></a>
|
|
1946
|
+
<span class="property-type">string</span>
|
|
1947
|
+
</dt>
|
|
1948
|
+
<dd>The ID of the thread that the message and files belong to.</dd>
|
|
1949
|
+
<dt>
|
|
1950
|
+
message_id
|
|
1951
|
+
<a
|
|
1952
|
+
href="https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-message_id"
|
|
1953
|
+
target="_blank"
|
|
1954
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1955
|
+
></a>
|
|
1956
|
+
<span class="property-type">string</span>
|
|
1957
|
+
</dt>
|
|
1958
|
+
<dd>The ID of the message that the files belongs to.</dd>
|
|
1959
|
+
<dt class="optional">
|
|
1960
|
+
limit
|
|
1961
|
+
<a
|
|
1962
|
+
href="https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-limit"
|
|
1963
|
+
target="_blank"
|
|
1964
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1965
|
+
></a>
|
|
1966
|
+
<span class="property-type">integer</span>
|
|
1967
|
+
</dt>
|
|
1968
|
+
<dd>A limit on the number of objects to be returned.</dd>
|
|
1969
|
+
<dt class="optional">
|
|
1970
|
+
order
|
|
1971
|
+
<a
|
|
1972
|
+
href="https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-order"
|
|
1973
|
+
target="_blank"
|
|
1974
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1975
|
+
></a>
|
|
1976
|
+
<span class="property-type">string</span>
|
|
1977
|
+
</dt>
|
|
1978
|
+
<dd>Sort order by the created_at timestamp of the objects.</dd>
|
|
1979
|
+
<dt class="optional">
|
|
1980
|
+
after
|
|
1981
|
+
<a
|
|
1982
|
+
href="https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-after"
|
|
1983
|
+
target="_blank"
|
|
1984
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1985
|
+
></a>
|
|
1986
|
+
<span class="property-type">string</span>
|
|
1987
|
+
</dt>
|
|
1988
|
+
<dd>A cursor for use in pagination.</dd>
|
|
1989
|
+
<dt class="optional">
|
|
1990
|
+
before
|
|
1991
|
+
<a
|
|
1992
|
+
href="https://platform.openai.com/docs/api-reference/messages/listMessageFiles#messages-listmessagefiles-before"
|
|
1993
|
+
target="_blank"
|
|
1994
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
1995
|
+
></a>
|
|
1996
|
+
<span class="property-type">string</span>
|
|
1997
|
+
</dt>
|
|
1998
|
+
<dd>A cursor for use in pagination.</dd>
|
|
516
1999
|
</dl>
|
|
517
2000
|
|
|
518
2001
|
<h3>Retrieve Message File</h3>
|
|
519
2002
|
<p>Retrieves a message file.</p>
|
|
520
2003
|
<dl class="message-properties">
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
<
|
|
2004
|
+
<h2>msg.payload Properties</h2>
|
|
2005
|
+
|
|
2006
|
+
<dt>
|
|
2007
|
+
thread_id
|
|
2008
|
+
<a
|
|
2009
|
+
href="https://platform.openai.com/docs/api-reference/messages/getMessageFile#messages-getmessagefile-thread_id"
|
|
2010
|
+
target="_blank"
|
|
2011
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2012
|
+
></a>
|
|
2013
|
+
<span class="property-type">string</span>
|
|
2014
|
+
</dt>
|
|
2015
|
+
<dd>The ID of the thread to which the message and File belong.</dd>
|
|
2016
|
+
<dt>
|
|
2017
|
+
message_id
|
|
2018
|
+
<a
|
|
2019
|
+
href="https://platform.openai.com/docs/api-reference/messages/getMessageFile#messages-getmessagefile-message_id"
|
|
2020
|
+
target="_blank"
|
|
2021
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2022
|
+
></a>
|
|
2023
|
+
<span class="property-type">string</span>
|
|
2024
|
+
</dt>
|
|
2025
|
+
<dd>The ID of the message the file belongs to.</dd>
|
|
2026
|
+
<dt>
|
|
2027
|
+
file_id
|
|
2028
|
+
<a
|
|
2029
|
+
href="https://platform.openai.com/docs/api-reference/messages/getMessageFile#messages-getmessagefile-file_id"
|
|
2030
|
+
target="_blank"
|
|
2031
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2032
|
+
></a>
|
|
2033
|
+
<span class="property-type">string</span>
|
|
2034
|
+
</dt>
|
|
2035
|
+
<dd>The ID of the file being retrieved.</dd>
|
|
526
2036
|
</dl>
|
|
527
|
-
|
|
2037
|
+
</section>
|
|
528
2038
|
|
|
529
|
-
|
|
2039
|
+
<section>
|
|
530
2040
|
<h1 style="font-weight: bold;">🧠 Models</h1>
|
|
531
|
-
<a
|
|
2041
|
+
<a
|
|
2042
|
+
href="https://platform.openai.com/docs/api-reference/models"
|
|
2043
|
+
target="_blank"
|
|
2044
|
+
>Official Documentation
|
|
2045
|
+
<i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2046
|
+
></a>
|
|
532
2047
|
<h2>List Models</h2>
|
|
533
|
-
<p>
|
|
2048
|
+
<p>
|
|
2049
|
+
Lists the currently available models, and provides basic information about
|
|
2050
|
+
each one such as the owner and availability.
|
|
2051
|
+
</p>
|
|
534
2052
|
<dl class="message-properties"></dl>
|
|
535
2053
|
|
|
536
2054
|
<h2>Retrieve Model</h2>
|
|
537
|
-
<p>
|
|
2055
|
+
<p>
|
|
2056
|
+
Retrieves a model instance, providing basic information about the model
|
|
2057
|
+
such as the owner and permissioning.
|
|
2058
|
+
</p>
|
|
538
2059
|
<dl class="message-properties">
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
2060
|
+
<h2>msg.payload Properties</h2>
|
|
2061
|
+
|
|
2062
|
+
<dt>
|
|
2063
|
+
model
|
|
2064
|
+
<a
|
|
2065
|
+
href="https://platform.openai.com/docs/api-reference/models/retrieve#models-retrieve-model"
|
|
2066
|
+
target="_blank"
|
|
2067
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2068
|
+
></a>
|
|
2069
|
+
<span class="property-type">string</span>
|
|
2070
|
+
</dt>
|
|
2071
|
+
<dd>The ID of the model to use for this request</dd>
|
|
542
2072
|
</dl>
|
|
543
2073
|
|
|
544
2074
|
<h2>Delete Fine-tun Model</h2>
|
|
545
|
-
<p>
|
|
2075
|
+
<p>
|
|
2076
|
+
Delete a fine-tuned model. You must have the Owner role in your
|
|
2077
|
+
organization to delete a model.
|
|
2078
|
+
</p>
|
|
546
2079
|
<dl class="message-properties">
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
2080
|
+
<h2>msg.payload Properties</h2>
|
|
2081
|
+
|
|
2082
|
+
<dt>
|
|
2083
|
+
model
|
|
2084
|
+
<a
|
|
2085
|
+
href="https://platform.openai.com/docs/api-reference/models/delete#models-delete-model"
|
|
2086
|
+
target="_blank"
|
|
2087
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2088
|
+
></a>
|
|
2089
|
+
<span class="property-type">string</span>
|
|
2090
|
+
</dt>
|
|
2091
|
+
<dd>The model to delete</dd>
|
|
550
2092
|
</dl>
|
|
551
2093
|
|
|
552
2094
|
<section>
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
2095
|
+
<h1 style="font-weight: bold;">✅ Moderations</h1>
|
|
2096
|
+
<a
|
|
2097
|
+
href="https://platform.openai.com/docs/api-reference/moderations"
|
|
2098
|
+
target="_blank"
|
|
2099
|
+
>Official Documentation
|
|
2100
|
+
<i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2101
|
+
></a>
|
|
2102
|
+
<h2>Create Moderation</h2>
|
|
2103
|
+
<p>Classifies if text violates OpenAI's Content Policy</p>
|
|
2104
|
+
<dl class="message-properties">
|
|
558
2105
|
<h2>msg.payload Properties</h2>
|
|
559
|
-
|
|
560
|
-
<dt>
|
|
561
|
-
|
|
562
|
-
|
|
2106
|
+
|
|
2107
|
+
<dt>
|
|
2108
|
+
input
|
|
2109
|
+
<a
|
|
2110
|
+
href="https://platform.openai.com/docs/api-reference/moderations/create#moderations-create-input"
|
|
2111
|
+
target="_blank"
|
|
2112
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2113
|
+
></a>
|
|
2114
|
+
<span class="property-type">string | array</span>
|
|
2115
|
+
</dt>
|
|
2116
|
+
<dd>The input text to classify</dd>
|
|
2117
|
+
<dt class="optional">
|
|
2118
|
+
model
|
|
2119
|
+
<a
|
|
2120
|
+
href="https://platform.openai.com/docs/api-reference/moderations/create#moderations-create-model"
|
|
2121
|
+
target="_blank"
|
|
2122
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2123
|
+
></a>
|
|
2124
|
+
<span class="property-type">string</span>
|
|
2125
|
+
</dt>
|
|
2126
|
+
<dd>
|
|
2127
|
+
Two content moderations models are available: text-moderation-stable
|
|
2128
|
+
and text-moderation-latest.
|
|
2129
|
+
</dd>
|
|
2130
|
+
</dl>
|
|
563
2131
|
</section>
|
|
564
2132
|
|
|
565
2133
|
<section>
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
2134
|
+
<h1 style="font-weight: bold;">🔄 Runs</h1>
|
|
2135
|
+
<a
|
|
2136
|
+
href="https://platform.openai.com/docs/api-reference/runs"
|
|
2137
|
+
target="_blank"
|
|
2138
|
+
>Official Documentation</a
|
|
2139
|
+
>
|
|
2140
|
+
<h2>Create Thread and Run</h2>
|
|
2141
|
+
<p>Create a thread and run it in one request.</p>
|
|
2142
|
+
<dl class="message-properties">
|
|
571
2143
|
<h2>msg.payload Properties</h2>
|
|
572
|
-
|
|
573
|
-
<dt>assistant_id <span class="property-type"></span></dt>
|
|
574
|
-
<dt class="optional">thread <span class="property-type">object</span></dt>
|
|
575
|
-
<dt class="optional">model <span class="property-type">string</span></dt>
|
|
576
|
-
<dt class="optional">instructions <span class="property-type">string</span></dt>
|
|
577
|
-
<dt class="optional">tools <span class="property-type">array</span></dt>
|
|
578
|
-
<dt class="optional">metadata <span class="property-type">object</span></dt>
|
|
579
|
-
</dl>
|
|
580
2144
|
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
2145
|
+
<dt>
|
|
2146
|
+
assistant_id
|
|
2147
|
+
<a
|
|
2148
|
+
href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-assistant_id"
|
|
2149
|
+
target="_blank"
|
|
2150
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2151
|
+
></a>
|
|
2152
|
+
<span class="property-type">string</span>
|
|
2153
|
+
</dt>
|
|
2154
|
+
<dd>The ID of the assistant to use to execute this run.</dd>
|
|
2155
|
+
<dt class="optional">
|
|
2156
|
+
thread
|
|
2157
|
+
<a
|
|
2158
|
+
href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-thread"
|
|
2159
|
+
target="_blank"
|
|
2160
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2161
|
+
></a>
|
|
2162
|
+
<span class="property-type">object</span>
|
|
2163
|
+
</dt>
|
|
2164
|
+
<dt class="optional">
|
|
2165
|
+
model
|
|
2166
|
+
<a
|
|
2167
|
+
href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-model"
|
|
2168
|
+
target="_blank"
|
|
2169
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2170
|
+
></a>
|
|
2171
|
+
<span class="property-type">string</span>
|
|
2172
|
+
</dt>
|
|
2173
|
+
<dd>The ID of the Model to be used to execute this run.</dd>
|
|
2174
|
+
<dt class="optional">
|
|
2175
|
+
instructions
|
|
2176
|
+
<a
|
|
2177
|
+
href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-instructions"
|
|
2178
|
+
target="_blank"
|
|
2179
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2180
|
+
></a>
|
|
2181
|
+
<span class="property-type">string</span>
|
|
2182
|
+
</dt>
|
|
2183
|
+
<dd>Override the default system message of the assistant.</dd>
|
|
2184
|
+
<dt class="optional">
|
|
2185
|
+
tools
|
|
2186
|
+
<a
|
|
2187
|
+
href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-tools"
|
|
2188
|
+
target="_blank"
|
|
2189
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2190
|
+
></a>
|
|
2191
|
+
<span class="property-type">array</span>
|
|
2192
|
+
</dt>
|
|
2193
|
+
<dd>Override the tools the assistant can use for this run.</dd>
|
|
2194
|
+
<dt class="optional">
|
|
2195
|
+
metadata
|
|
2196
|
+
<a
|
|
2197
|
+
href="https://platform.openai.com/docs/api-reference/runs/createThreadAndRun#runs-createthreadandrun-metadata"
|
|
2198
|
+
target="_blank"
|
|
2199
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2200
|
+
></a>
|
|
2201
|
+
<span class="property-type">object</span>
|
|
2202
|
+
</dt>
|
|
2203
|
+
<dd>Set of 16 key-value pairs that can be attached to an object.</dd>
|
|
2204
|
+
</dl>
|
|
2205
|
+
|
|
2206
|
+
<h2>List Runs</h2>
|
|
2207
|
+
<p>Returns a list of runs belonging to a thread.</p>
|
|
2208
|
+
<dl class="message-properties">
|
|
584
2209
|
<h2>msg.payload Properties</h2>
|
|
585
|
-
|
|
586
|
-
<dt>thread_id <span class="property-type">string</span></dt>
|
|
587
|
-
|
|
588
|
-
<dt class="optional">limit <span class="property-type">integer</span></dt>
|
|
589
|
-
<dt class="optional">order <span class="property-type">string</span></dt>
|
|
590
|
-
<dt class="optional">after <span class="property-type">string</span></dt>
|
|
591
|
-
<dt class="optional">before <span class="property-type">string</span></dt>
|
|
592
|
-
</dl>
|
|
593
2210
|
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
2211
|
+
<dt>
|
|
2212
|
+
thread_id
|
|
2213
|
+
<a
|
|
2214
|
+
href="https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-thread_id"
|
|
2215
|
+
target="_blank"
|
|
2216
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2217
|
+
></a>
|
|
2218
|
+
<span class="property-type">string</span>
|
|
2219
|
+
</dt>
|
|
2220
|
+
<dd>The ID of the thread the run belongs to.</dd>
|
|
2221
|
+
<dt class="optional">
|
|
2222
|
+
limit
|
|
2223
|
+
<a
|
|
2224
|
+
href="https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-limit"
|
|
2225
|
+
target="_blank"
|
|
2226
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2227
|
+
></a>
|
|
2228
|
+
<span class="property-type">integer</span>
|
|
2229
|
+
</dt>
|
|
2230
|
+
<dd>A limit on the number of objects to be returned.</dd>
|
|
2231
|
+
<dt class="optional">
|
|
2232
|
+
order
|
|
2233
|
+
<a
|
|
2234
|
+
href="https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-order"
|
|
2235
|
+
target="_blank"
|
|
2236
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2237
|
+
></a>
|
|
2238
|
+
<span class="property-type">string</span>
|
|
2239
|
+
</dt>
|
|
2240
|
+
<dd>Sort order by the created_at timestamp of the objects.</dd>
|
|
2241
|
+
<dt class="optional">
|
|
2242
|
+
after
|
|
2243
|
+
<a
|
|
2244
|
+
href="https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-after"
|
|
2245
|
+
target="_blank"
|
|
2246
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2247
|
+
></a>
|
|
2248
|
+
<span class="property-type">string</span>
|
|
2249
|
+
</dt>
|
|
2250
|
+
<dd>A cursor for use in pagination.</dd>
|
|
2251
|
+
<dt class="optional">
|
|
2252
|
+
before
|
|
2253
|
+
<a
|
|
2254
|
+
href="https://platform.openai.com/docs/api-reference/runs/listRuns#runs-listruns-before"
|
|
2255
|
+
target="_blank"
|
|
2256
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2257
|
+
></a>
|
|
2258
|
+
<span class="property-type">string</span>
|
|
2259
|
+
</dt>
|
|
2260
|
+
<dd>A cursor for use in pagination.</dd>
|
|
2261
|
+
</dl>
|
|
2262
|
+
|
|
2263
|
+
<h2>Create Run</h2>
|
|
2264
|
+
<p>Create a run.</p>
|
|
2265
|
+
<dl class="message-properties">
|
|
597
2266
|
<h2>msg.payload Properties</h2>
|
|
598
|
-
|
|
599
|
-
<dt>thread_id <span class="property-type">string</span></dt>
|
|
600
|
-
|
|
601
|
-
<dt>assistant_id <span class="property-type">string</span></dt>
|
|
602
|
-
<dt class="optional">model <span class="property-type">string</span></dt>
|
|
603
|
-
<dt class="optional">instructions <span class="property-type">string</span></dt>
|
|
604
|
-
<dt class="optional">tools <span class="property-type"></span>array</dt>
|
|
605
|
-
<dt class="optional">metadata <span class="property-type">object</span></dt>
|
|
606
|
-
</dl>
|
|
607
2267
|
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
2268
|
+
<dt>
|
|
2269
|
+
thread_id
|
|
2270
|
+
<a
|
|
2271
|
+
href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-thread_id"
|
|
2272
|
+
target="_blank"
|
|
2273
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2274
|
+
></a>
|
|
2275
|
+
<span class="property-type">string</span>
|
|
2276
|
+
</dt>
|
|
2277
|
+
<dd>The ID of the thread to run.</dd>
|
|
2278
|
+
<dt>
|
|
2279
|
+
assistant_id
|
|
2280
|
+
<a
|
|
2281
|
+
href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-assistant_id"
|
|
2282
|
+
target="_blank"
|
|
2283
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2284
|
+
></a>
|
|
2285
|
+
<span class="property-type">string</span>
|
|
2286
|
+
</dt>
|
|
2287
|
+
<dd>The ID of the assistant to use to execute this run.</dd>
|
|
2288
|
+
<dt class="optional">
|
|
2289
|
+
model
|
|
2290
|
+
<a
|
|
2291
|
+
href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-model"
|
|
2292
|
+
target="_blank"
|
|
2293
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2294
|
+
></a>
|
|
2295
|
+
<span class="property-type">string</span>
|
|
2296
|
+
</dt>
|
|
2297
|
+
<dd>The ID of the Model to be used to execute this run.</dd>
|
|
2298
|
+
<dt class="optional">
|
|
2299
|
+
instructions
|
|
2300
|
+
<a
|
|
2301
|
+
href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-instructions"
|
|
2302
|
+
target="_blank"
|
|
2303
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2304
|
+
></a>
|
|
2305
|
+
<span class="property-type">string</span>
|
|
2306
|
+
</dt>
|
|
2307
|
+
<dd>
|
|
2308
|
+
Appends additional instructions at the end of the instructions for the
|
|
2309
|
+
run.
|
|
2310
|
+
</dd>
|
|
2311
|
+
<dt class="optional">
|
|
2312
|
+
tools
|
|
2313
|
+
<a
|
|
2314
|
+
href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-tools"
|
|
2315
|
+
target="_blank"
|
|
2316
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2317
|
+
></a>
|
|
2318
|
+
<span class="property-type"></span>array
|
|
2319
|
+
</dt>
|
|
2320
|
+
<dd>Override the tools the assistant can use for this run.</dd>
|
|
2321
|
+
<dt class="optional">
|
|
2322
|
+
metadata
|
|
2323
|
+
<a
|
|
2324
|
+
href="https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-metadata"
|
|
2325
|
+
target="_blank"
|
|
2326
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2327
|
+
></a>
|
|
2328
|
+
<span class="property-type">object</span>
|
|
2329
|
+
</dt>
|
|
2330
|
+
<dd>Set of 16 key-value pairs that can be attached to an object.</dd>
|
|
2331
|
+
</dl>
|
|
2332
|
+
|
|
2333
|
+
<h2>Retrieve Run</h2>
|
|
2334
|
+
<p>Retrieves a run.</p>
|
|
2335
|
+
<dl class="message-properties">
|
|
611
2336
|
<h2>msg.payload Properties</h2>
|
|
612
|
-
|
|
2337
|
+
|
|
613
2338
|
<dt>thread_id <span class="property-type">string</span></dt>
|
|
2339
|
+
<dd>The ID of the thread that was run.</dd>
|
|
614
2340
|
<dt>run_id <span class="property-type">string</span></dt>
|
|
615
|
-
|
|
2341
|
+
<dd>The ID of the run to retrieve.</dd>
|
|
2342
|
+
</dl>
|
|
616
2343
|
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
2344
|
+
<h2>Modify Run</h2>
|
|
2345
|
+
<p>Modifies a run.</p>
|
|
2346
|
+
<dl class="message-properties">
|
|
620
2347
|
<h2>msg.payload Properties</h2>
|
|
621
|
-
|
|
622
|
-
<dt>thread_id <span class="property-type">string</span></dt>
|
|
623
|
-
<dt>run_id <span class="property-type">string</span></dt>
|
|
624
|
-
|
|
625
|
-
<dt class="optional">metadata <span class="property-type">object</span></dt>
|
|
626
|
-
</dl>
|
|
627
2348
|
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
2349
|
+
<dt>
|
|
2350
|
+
thread_id
|
|
2351
|
+
<a
|
|
2352
|
+
href="https://platform.openai.com/docs/api-reference/runs/getRun#runs-getrun-thread_id"
|
|
2353
|
+
target="_blank"
|
|
2354
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2355
|
+
></a>
|
|
2356
|
+
<span class="property-type">string</span>
|
|
2357
|
+
</dt>
|
|
2358
|
+
<dd>The ID of the thread that was run.</dd>
|
|
2359
|
+
<dt>
|
|
2360
|
+
run_id
|
|
2361
|
+
<a
|
|
2362
|
+
href="https://platform.openai.com/docs/api-reference/runs/getRun#runs-getrun-run_id"
|
|
2363
|
+
target="_blank"
|
|
2364
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2365
|
+
></a>
|
|
2366
|
+
<span class="property-type">string</span>
|
|
2367
|
+
</dt>
|
|
2368
|
+
<dd>The ID of the run to modify.</dd>
|
|
2369
|
+
<dt class="optional">
|
|
2370
|
+
metadata
|
|
2371
|
+
<a
|
|
2372
|
+
href="https://platform.openai.com/docs/api-reference/runs/modifyRun#runs-modifyrun-metadata"
|
|
2373
|
+
target="_blank"
|
|
2374
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2375
|
+
></a>
|
|
2376
|
+
<span class="property-type">object</span>
|
|
2377
|
+
</dt>
|
|
2378
|
+
<dd>Set of 16 key-value pairs that can be attached to an object.</dd>
|
|
2379
|
+
</dl>
|
|
2380
|
+
|
|
2381
|
+
<h2>Submit Tool Outputs to Run</h2>
|
|
2382
|
+
<p>
|
|
2383
|
+
When a run has the `status: "requires_action"` and
|
|
2384
|
+
`required_action.type` is `submit_tool_outputs`, this endpoint can be
|
|
2385
|
+
used to submit the outputs from the tool calls once they're all
|
|
2386
|
+
completed. All outputs must be submitted in a single request.
|
|
2387
|
+
</p>
|
|
2388
|
+
<dl class="message-properties">
|
|
631
2389
|
<h2>msg.payload Properties</h2>
|
|
632
|
-
|
|
633
|
-
<dt>thread_id <span class="property-type">string</span></dt>
|
|
634
|
-
<dt>run_id <span class="property-type">string</span></dt>
|
|
635
|
-
|
|
636
|
-
<dt>tool_outputs <span class="property-type">array</span></dt>
|
|
637
|
-
</dl>
|
|
638
2390
|
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
2391
|
+
<dt>
|
|
2392
|
+
thread_id
|
|
2393
|
+
<a
|
|
2394
|
+
href="https://platform.openai.com/docs/api-reference/runs/submitToolOutputs#runs-submittooloutputs-thread_id"
|
|
2395
|
+
target="_blank"
|
|
2396
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2397
|
+
></a>
|
|
2398
|
+
<span class="property-type">string</span>
|
|
2399
|
+
</dt>
|
|
2400
|
+
<dd>The ID of the thread to which this run belongs.</dd>
|
|
2401
|
+
<dt>
|
|
2402
|
+
run_id
|
|
2403
|
+
<a
|
|
2404
|
+
href="https://platform.openai.com/docs/api-reference/runs/submitToolOutputs#runs-submittooloutputs-run_id"
|
|
2405
|
+
target="_blank"
|
|
2406
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2407
|
+
></a>
|
|
2408
|
+
<span class="property-type">string</span>
|
|
2409
|
+
</dt>
|
|
2410
|
+
<dd>The ID of the run that requires the tool output submission.</dd>
|
|
2411
|
+
<dt>
|
|
2412
|
+
tool_outputs
|
|
2413
|
+
<a
|
|
2414
|
+
href="https://platform.openai.com/docs/api-reference/runs/submitToolOutputs#runs-submittooloutputs-tool_outputs"
|
|
2415
|
+
target="_blank"
|
|
2416
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2417
|
+
></a>
|
|
2418
|
+
<span class="property-type">array</span>
|
|
2419
|
+
</dt>
|
|
2420
|
+
<dd>A list of tools for which the outputs are being submitted.</dd>
|
|
2421
|
+
</dl>
|
|
2422
|
+
|
|
2423
|
+
<h2>Cancel Run</h2>
|
|
2424
|
+
<p>Cancels a run that is `in_progress`.</p>
|
|
2425
|
+
<dl class="message-properties">
|
|
642
2426
|
<h2>msg.payload Properties</h2>
|
|
643
|
-
|
|
644
|
-
<dt>thread_id <span class="property-type">string</span></dt>
|
|
645
|
-
<dt>run_id <span class="property-type">string</span></dt>
|
|
646
|
-
</dl>
|
|
647
2427
|
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
2428
|
+
<dt>
|
|
2429
|
+
thread_id
|
|
2430
|
+
<a
|
|
2431
|
+
href="https://platform.openai.com/docs/api-reference/runs/cancelRun#runs-cancelrun-thread_id"
|
|
2432
|
+
target="_blank"
|
|
2433
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2434
|
+
></a>
|
|
2435
|
+
<span class="property-type">string</span>
|
|
2436
|
+
</dt>
|
|
2437
|
+
<dd>The ID of the thread to which this run belongs.</dd>
|
|
2438
|
+
<dt>
|
|
2439
|
+
run_id
|
|
2440
|
+
<a
|
|
2441
|
+
href="https://platform.openai.com/docs/api-reference/runs/cancelRun#runs-cancelrun-run_id"
|
|
2442
|
+
target="_blank"
|
|
2443
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2444
|
+
></a>
|
|
2445
|
+
<span class="property-type">string</span>
|
|
2446
|
+
</dt>
|
|
2447
|
+
<dd>The ID of the run to cancel.</dd>
|
|
2448
|
+
</dl>
|
|
2449
|
+
|
|
2450
|
+
<h2>List Run Steps</h2>
|
|
2451
|
+
<p>Returns a list of run steps belonging to a run.</p>
|
|
2452
|
+
<dl class="message-properties">
|
|
651
2453
|
<h2>msg.payload Properties</h2>
|
|
652
|
-
|
|
653
|
-
<dt>thread_id <span class="property-type">string</span></dt>
|
|
654
|
-
<dt>run_id <span class="property-type">string</span></dt>
|
|
655
|
-
<dt class="optional">limit <span class="property-type">integer</span></dt>
|
|
656
|
-
<dt class="optional">order <span class="property-type">string</span></dt>
|
|
657
|
-
<dt class="optional">after <span class="property-type">string</span></dt>
|
|
658
|
-
<dt class="optional">before <span class="property-type">string</span></dt>
|
|
659
|
-
</dl>
|
|
660
2454
|
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
2455
|
+
<dt>
|
|
2456
|
+
thread_id
|
|
2457
|
+
<a
|
|
2458
|
+
href="https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-thread_id"
|
|
2459
|
+
target="_blank"
|
|
2460
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2461
|
+
></a>
|
|
2462
|
+
<span class="property-type">string</span>
|
|
2463
|
+
</dt>
|
|
2464
|
+
<dd>The ID of the thread the run and run steps belong to.</dd>
|
|
2465
|
+
<dt>
|
|
2466
|
+
run_id
|
|
2467
|
+
<a
|
|
2468
|
+
href="https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-run_id"
|
|
2469
|
+
target="_blank"
|
|
2470
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2471
|
+
></a>
|
|
2472
|
+
<span class="property-type">string</span>
|
|
2473
|
+
</dt>
|
|
2474
|
+
<dd>The ID of the run the run steps belong to.</dd>
|
|
2475
|
+
<dt class="optional">
|
|
2476
|
+
limit
|
|
2477
|
+
<a
|
|
2478
|
+
href="https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-limit"
|
|
2479
|
+
target="_blank"
|
|
2480
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2481
|
+
></a>
|
|
2482
|
+
<span class="property-type">integer</span>
|
|
2483
|
+
</dt>
|
|
2484
|
+
<dd>A limit on the number of objects to be returned.</dd>
|
|
2485
|
+
<dt class="optional">
|
|
2486
|
+
order
|
|
2487
|
+
<a
|
|
2488
|
+
href="https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-order"
|
|
2489
|
+
target="_blank"
|
|
2490
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2491
|
+
></a>
|
|
2492
|
+
<span class="property-type">string</span>
|
|
2493
|
+
</dt>
|
|
2494
|
+
<dd>Sort order by the created_at timestamp of the objects.</dd>
|
|
2495
|
+
<dt class="optional">
|
|
2496
|
+
after
|
|
2497
|
+
<a
|
|
2498
|
+
href="https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-after"
|
|
2499
|
+
target="_blank"
|
|
2500
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2501
|
+
></a>
|
|
2502
|
+
<span class="property-type">string</span>
|
|
2503
|
+
</dt>
|
|
2504
|
+
<dd>A cursor for use in pagination.</dd>
|
|
2505
|
+
<dt class="optional">
|
|
2506
|
+
before
|
|
2507
|
+
<a
|
|
2508
|
+
href="https://platform.openai.com/docs/api-reference/runs/listRunSteps#runs-listrunsteps-before"
|
|
2509
|
+
target="_blank"
|
|
2510
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2511
|
+
></a>
|
|
2512
|
+
<span class="property-type">string</span>
|
|
2513
|
+
</dt>
|
|
2514
|
+
<dd>A cursor for use in pagination.</dd>
|
|
2515
|
+
</dl>
|
|
2516
|
+
|
|
2517
|
+
<h2>Retrieve Run Step</h2>
|
|
2518
|
+
<p>Retrieves a run step.</p>
|
|
2519
|
+
<dl class="message-properties">
|
|
664
2520
|
<h2>msg.payload Properties</h2>
|
|
665
|
-
|
|
666
|
-
<dt>
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
2521
|
+
|
|
2522
|
+
<dt>
|
|
2523
|
+
thread_id
|
|
2524
|
+
<a
|
|
2525
|
+
href="https://platform.openai.com/docs/api-reference/runs/getRunStep#runs-getrunstep-thread_id"
|
|
2526
|
+
target="_blank"
|
|
2527
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2528
|
+
></a>
|
|
2529
|
+
<span class="property-type">string</span>
|
|
2530
|
+
</dt>
|
|
2531
|
+
<dd>The ID of the thread to which the run and run step belongs.</dd>
|
|
2532
|
+
<dt>
|
|
2533
|
+
run_id
|
|
2534
|
+
<a
|
|
2535
|
+
href="https://platform.openai.com/docs/api-reference/runs/getRunStep#runs-getrunstep-run_id"
|
|
2536
|
+
target="_blank"
|
|
2537
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2538
|
+
></a>
|
|
2539
|
+
<span class="property-type">string</span>
|
|
2540
|
+
</dt>
|
|
2541
|
+
<dd>The ID of the run to which the run step belongs.</dd>
|
|
2542
|
+
<dt>
|
|
2543
|
+
step_id
|
|
2544
|
+
<a
|
|
2545
|
+
href="https://platform.openai.com/docs/api-reference/runs/getRunStep#runs-getrunstep-step_id"
|
|
2546
|
+
target="_blank"
|
|
2547
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2548
|
+
></a>
|
|
2549
|
+
<span class="property-type">string</span>
|
|
2550
|
+
</dt>
|
|
2551
|
+
<dd>The ID of the run step to retrieve.</dd>
|
|
2552
|
+
</dl>
|
|
670
2553
|
</section>
|
|
671
2554
|
|
|
672
2555
|
<section>
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
2556
|
+
<h1 style="font-weight: bold;">🧵 Threads</h1>
|
|
2557
|
+
<a
|
|
2558
|
+
href="https://platform.openai.com/docs/api-reference/threads"
|
|
2559
|
+
target="_blank"
|
|
2560
|
+
>Official Documentation
|
|
2561
|
+
<i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2562
|
+
></a>
|
|
2563
|
+
<h2>Create Thread</h2>
|
|
2564
|
+
<p>Create a thread.</p>
|
|
2565
|
+
<dl class="message-properties">
|
|
678
2566
|
<h2>msg.payload Properties</h2>
|
|
679
|
-
|
|
680
|
-
<dt class="optional">messages <span class="property-type">array</span></dt>
|
|
681
|
-
<dt class="optional">metadata <span class="property-type">object</span></dt>
|
|
682
|
-
</dl>
|
|
683
2567
|
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
2568
|
+
<dt class="optional">
|
|
2569
|
+
messages
|
|
2570
|
+
<a
|
|
2571
|
+
href="https://platform.openai.com/docs/api-reference/threads/createThread#threads-createthread-messages"
|
|
2572
|
+
target="_blank"
|
|
2573
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2574
|
+
></a>
|
|
2575
|
+
<span class="property-type">array</span>
|
|
2576
|
+
</dt>
|
|
2577
|
+
<dd>A list of messages to start the thread with.</dd>
|
|
2578
|
+
<dt class="optional">
|
|
2579
|
+
metadata
|
|
2580
|
+
<a
|
|
2581
|
+
href="https://platform.openai.com/docs/api-reference/threads/createThread#threads-createthread-metadata"
|
|
2582
|
+
target="_blank"
|
|
2583
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2584
|
+
></a>
|
|
2585
|
+
<span class="property-type">object</span>
|
|
2586
|
+
</dt>
|
|
2587
|
+
<dd>Set of 16 key-value pairs that can be attached to an object.</dd>
|
|
2588
|
+
</dl>
|
|
2589
|
+
|
|
2590
|
+
<h2>Retrieve Thread</h2>
|
|
2591
|
+
<p>Retrieves a thread.</p>
|
|
2592
|
+
<dl class="message-properties">
|
|
687
2593
|
<h2>msg.payload Properties</h2>
|
|
688
|
-
|
|
689
|
-
<dt>thread_id <span class="property-type">string</span></dt>
|
|
690
|
-
</dl>
|
|
691
2594
|
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
2595
|
+
<dt>
|
|
2596
|
+
thread_id
|
|
2597
|
+
<a
|
|
2598
|
+
href="https://platform.openai.com/docs/api-reference/threads/getThread#threads-getthread-thread_id"
|
|
2599
|
+
target="_blank"
|
|
2600
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2601
|
+
></a>
|
|
2602
|
+
<span class="property-type">string</span>
|
|
2603
|
+
</dt>
|
|
2604
|
+
<dd>The ID of the thread to retrieve.</dd>
|
|
2605
|
+
</dl>
|
|
2606
|
+
|
|
2607
|
+
<h2>Modify Thread</h2>
|
|
2608
|
+
<p>Modifies a thread.</p>
|
|
2609
|
+
<dl class="message-properties">
|
|
695
2610
|
<h2>msg.payload Properties</h2>
|
|
696
|
-
|
|
697
|
-
<dt>thread_id <span class="property-type">string</span></dt>
|
|
698
|
-
|
|
699
|
-
<dt class="optional">metadata <span class="property-type">object</span></dt>
|
|
700
|
-
</dl>
|
|
701
2611
|
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
2612
|
+
<dt>
|
|
2613
|
+
thread_id
|
|
2614
|
+
<a
|
|
2615
|
+
href="https://platform.openai.com/docs/api-reference/threads/modifyThread#threads-modifythread-thread_id"
|
|
2616
|
+
target="_blank"
|
|
2617
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2618
|
+
></a>
|
|
2619
|
+
<span class="property-type">string</span>
|
|
2620
|
+
</dt>
|
|
2621
|
+
<dd>
|
|
2622
|
+
The ID of the thread to modify. Only the metadata can be modified.
|
|
2623
|
+
</dd>
|
|
2624
|
+
<dt class="optional">
|
|
2625
|
+
metadata
|
|
2626
|
+
<a
|
|
2627
|
+
href="https://platform.openai.com/docs/api-reference/threads/modifyThread#threads-modifythread-metadata"
|
|
2628
|
+
target="_blank"
|
|
2629
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2630
|
+
></a>
|
|
2631
|
+
<span class="property-type">object</span>
|
|
2632
|
+
</dt>
|
|
2633
|
+
<dd>Set of 16 key-value pairs that can be attached to an object.</dd>
|
|
2634
|
+
</dl>
|
|
2635
|
+
|
|
2636
|
+
<h2>Delete Thread</h2>
|
|
2637
|
+
<p>Delete a thread.</p>
|
|
2638
|
+
<dl class="message-properties">
|
|
705
2639
|
<h2>msg.payload Properties</h2>
|
|
706
|
-
|
|
707
|
-
<dt>
|
|
708
|
-
|
|
2640
|
+
|
|
2641
|
+
<dt>
|
|
2642
|
+
thread_id
|
|
2643
|
+
<a
|
|
2644
|
+
href="https://platform.openai.com/docs/api-reference/threads/deleteThread#threads-deletethread-thread_id"
|
|
2645
|
+
target="_blank"
|
|
2646
|
+
><i class="fa fa-external-link fa-sm" aria-hidden="true"></i
|
|
2647
|
+
></a>
|
|
2648
|
+
<span class="property-type">string</span>
|
|
2649
|
+
</dt>
|
|
2650
|
+
<dd>The ID of the thread to delete.</dd>
|
|
2651
|
+
</dl>
|
|
709
2652
|
</section>
|
|
2653
|
+
</section>
|
|
710
2654
|
</script>
|
|
711
2655
|
|
|
712
2656
|
<script type="text/javascript">
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
2657
|
+
RED.nodes.registerType("Service Host", {
|
|
2658
|
+
category: "config",
|
|
2659
|
+
defaults: {
|
|
2660
|
+
apiBase: { value: "https://api.openai.com/v1", required: true },
|
|
2661
|
+
secureApiKeyHeaderOrQueryName: { value: "Authorization" },
|
|
2662
|
+
organizationId: { value: "" },
|
|
2663
|
+
secureApiKeyIsQuery: { value: false },
|
|
2664
|
+
name: { value: "" },
|
|
2665
|
+
},
|
|
2666
|
+
credentials: {
|
|
2667
|
+
secureApiKeyValue: { type: "password" },
|
|
2668
|
+
temp: { type: "text" },
|
|
2669
|
+
},
|
|
2670
|
+
label: function () {
|
|
2671
|
+
return this.name || this.host;
|
|
2672
|
+
},
|
|
2673
|
+
labelStyle: function () {
|
|
2674
|
+
return this.name ? "node_label_italic" : "";
|
|
2675
|
+
},
|
|
2676
|
+
oneditprepare: function () {
|
|
2677
|
+
$("#node-config-input-secureApiKeyIsQuery-label").hide();
|
|
2678
|
+
$("#node-config-input-secureApiKeyIsQuery").hide();
|
|
2679
|
+
var selected = $(
|
|
2680
|
+
"#node-config-input-secureApiKeyIsQuery option:selected",
|
|
2681
|
+
);
|
|
2682
|
+
if (!selected.val()) {
|
|
2683
|
+
$("#node-config-input-secureApiKeyIsQuery").val(false);
|
|
2684
|
+
}
|
|
2685
|
+
},
|
|
2686
|
+
});
|
|
741
2687
|
</script>
|
|
742
2688
|
|
|
743
2689
|
<script type="text/html" data-template-name="Service Host">
|
|
2690
|
+
<div class="form-row">
|
|
2691
|
+
<label id="node-config-input-apiBase-label" for="node-config-input-apiBase"
|
|
2692
|
+
><i class="fa fa-list"></i>
|
|
2693
|
+
<span data-i18n="OpenaiApi.label.apiBase"></span
|
|
2694
|
+
></label>
|
|
2695
|
+
<input
|
|
2696
|
+
type="text"
|
|
2697
|
+
id="node-config-input-apiBase"
|
|
2698
|
+
placeholder="https://api.openai.com/v1"
|
|
2699
|
+
/>
|
|
2700
|
+
</div>
|
|
2701
|
+
<div class="form-row">
|
|
2702
|
+
<label
|
|
2703
|
+
id="node-config-input-secureApiKeyHeaderOrQueryName-label"
|
|
2704
|
+
for="node-config-input-secureApiKeyHeaderOrQueryName"
|
|
2705
|
+
><i class="fa fa-list"></i>
|
|
2706
|
+
<span data-i18n="OpenaiApi.label.header"></span
|
|
2707
|
+
></label>
|
|
2708
|
+
<input
|
|
2709
|
+
type="text"
|
|
2710
|
+
id="node-config-input-secureApiKeyHeaderOrQueryName"
|
|
2711
|
+
placeholder=""
|
|
2712
|
+
/>
|
|
2713
|
+
</div>
|
|
2714
|
+
<div class="form-row">
|
|
2715
|
+
<label
|
|
2716
|
+
id="node-config-input-secureApiKeyValue-label"
|
|
2717
|
+
for="node-config-input-secureApiKeyValue"
|
|
2718
|
+
><i class="fa fa-lock"></i>
|
|
2719
|
+
<span data-i18n="OpenaiApi.label.apiKey"></span
|
|
2720
|
+
></label>
|
|
2721
|
+
<input
|
|
2722
|
+
type="password"
|
|
2723
|
+
id="node-config-input-secureApiKeyValue"
|
|
2724
|
+
placeholder=""
|
|
2725
|
+
/>
|
|
2726
|
+
</div>
|
|
2727
|
+
<div class="form-row">
|
|
2728
|
+
<label
|
|
2729
|
+
id="node-config-input-organizationId-label"
|
|
2730
|
+
for="node-config-input-organizationId"
|
|
2731
|
+
><i class="fa fa-list"></i>
|
|
2732
|
+
<span data-i18n="OpenaiApi.label.organizationId"></span
|
|
2733
|
+
></label>
|
|
2734
|
+
<input
|
|
2735
|
+
type="text"
|
|
2736
|
+
id="node-config-input-organizationId"
|
|
2737
|
+
placeholder="OpenAI Organization Id"
|
|
2738
|
+
/>
|
|
2739
|
+
</div>
|
|
2740
|
+
<div class="form-row">
|
|
2741
|
+
<label
|
|
2742
|
+
id="node-config-input-secureApiKeyIsQuery-label"
|
|
2743
|
+
for="node-config-input-secureApiKeyIsQuery"
|
|
2744
|
+
><i class="fa fa-dot-circle-o"></i>
|
|
2745
|
+
<span data-i18n="OpenaiApi.label.isQuery"></span
|
|
2746
|
+
></label>
|
|
2747
|
+
<select id="node-config-input-secureApiKeyIsQuery">
|
|
2748
|
+
<option value="true">true</option>
|
|
2749
|
+
<option value="false">false</option>
|
|
2750
|
+
</select>
|
|
2751
|
+
</div>
|
|
744
2752
|
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
</div>
|
|
757
|
-
<div class="form-row">
|
|
758
|
-
<label id="node-config-input-organizationId-label" for="node-config-input-organizationId"><i class="fa fa-list"></i> <span data-i18n="OpenaiApi.label.organizationId"></span></label>
|
|
759
|
-
<input type="text" id="node-config-input-organizationId" placeholder="OpenAI Organization Id">
|
|
760
|
-
</div>
|
|
761
|
-
<div class="form-row">
|
|
762
|
-
<label id="node-config-input-secureApiKeyIsQuery-label" for="node-config-input-secureApiKeyIsQuery"><i class="fa fa-dot-circle-o"></i> <span data-i18n="OpenaiApi.label.isQuery"></span></label>
|
|
763
|
-
<select id="node-config-input-secureApiKeyIsQuery">
|
|
764
|
-
<option value="true">true</option>
|
|
765
|
-
<option value="false">false</option>
|
|
766
|
-
</select>
|
|
767
|
-
</div>
|
|
768
|
-
|
|
769
|
-
<div class="form-row">
|
|
770
|
-
<label for="node-config-input-name"><i class="fa fa-tag"></i> <span data-i18n="node-red:common.label.name"></span></label>
|
|
771
|
-
<input type="text" id="node-config-input-name" data-i18n="[placeholder]node-red:common.label.name">
|
|
772
|
-
</div>
|
|
2753
|
+
<div class="form-row">
|
|
2754
|
+
<label for="node-config-input-name"
|
|
2755
|
+
><i class="fa fa-tag"></i>
|
|
2756
|
+
<span data-i18n="node-red:common.label.name"></span
|
|
2757
|
+
></label>
|
|
2758
|
+
<input
|
|
2759
|
+
type="text"
|
|
2760
|
+
id="node-config-input-name"
|
|
2761
|
+
data-i18n="[placeholder]node-red:common.label.name"
|
|
2762
|
+
/>
|
|
2763
|
+
</div>
|
|
773
2764
|
</script>
|
|
774
2765
|
|
|
775
2766
|
<script type="text/html" data-help-name="Service Host">
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
</script>
|
|
2767
|
+
<p><b>Header</b>: Variable name to set API key</p>
|
|
2768
|
+
<p><b>Value</b>: Value of API key</p>
|
|
2769
|
+
</script>
|