cli/resources/skills/subresources/versions/index.md +0 −443 deleted
File Deleted View Diff
1# Versions
2
3## Create a new immutable skill version.
4
5`$ openai skills:versions create`
6
7**post** `/skills/{skill_id}/versions`
8
9Create a new immutable skill version.
10
11### Parameters
12
13- `--skill-id: string`
14
15 The identifier of the skill to version.
16
17- `--default: optional boolean`
18
19 Whether to set this version as the default.
20
21- `--files: optional array of string or string`
22
23 Skill files to upload (directory upload) or a single zip file.
24
25### Returns
26
27- `skill_version: object { id, created_at, description, 4 more }`
28
29 - `id: string`
30
31 Unique identifier for the skill version.
32
33 - `created_at: number`
34
35 Unix timestamp (seconds) for when the version was created.
36
37 - `description: string`
38
39 Description of the skill version.
40
41 - `name: string`
42
43 Name of the skill version.
44
45 - `object: "skill.version"`
46
47 The object type, which is `skill.version`.
48
49 - `skill_id: string`
50
51 Identifier of the skill for this version.
52
53 - `version: string`
54
55 Version number for this skill.
56
57### Example
58
59```cli
60openai skills:versions create \
61 --api-key 'My API Key' \
62 --skill-id skill_123
63```
64
65#### Response
66
67```json
68{
69 "id": "id",
70 "created_at": 0,
71 "description": "description",
72 "name": "name",
73 "object": "skill.version",
74 "skill_id": "skill_id",
75 "version": "version"
76}
77```
78
79## List skill versions for a skill.
80
81`$ openai skills:versions list`
82
83**get** `/skills/{skill_id}/versions`
84
85List skill versions for a skill.
86
87### Parameters
88
89- `--skill-id: string`
90
91 The identifier of the skill.
92
93- `--after: optional string`
94
95 The skill version ID to start after.
96
97- `--limit: optional number`
98
99 Number of versions to retrieve.
100
101- `--order: optional "asc" or "desc"`
102
103 Sort order of results by version number.
104
105### Returns
106
107- `skill_version_list: object { data, first_id, has_more, 2 more }`
108
109 - `data: array of SkillVersion`
110
111 A list of items
112
113 - `id: string`
114
115 Unique identifier for the skill version.
116
117 - `created_at: number`
118
119 Unix timestamp (seconds) for when the version was created.
120
121 - `description: string`
122
123 Description of the skill version.
124
125 - `name: string`
126
127 Name of the skill version.
128
129 - `object: "skill.version"`
130
131 The object type, which is `skill.version`.
132
133 - `skill_id: string`
134
135 Identifier of the skill for this version.
136
137 - `version: string`
138
139 Version number for this skill.
140
141 - `first_id: string`
142
143 The ID of the first item in the list.
144
145 - `has_more: boolean`
146
147 Whether there are more items available.
148
149 - `last_id: string`
150
151 The ID of the last item in the list.
152
153 - `object: "list"`
154
155 The type of object returned, must be `list`.
156
157### Example
158
159```cli
160openai skills:versions list \
161 --api-key 'My API Key' \
162 --skill-id skill_123
163```
164
165#### Response
166
167```json
168{
169 "data": [
170 {
171 "id": "id",
172 "created_at": 0,
173 "description": "description",
174 "name": "name",
175 "object": "skill.version",
176 "skill_id": "skill_id",
177 "version": "version"
178 }
179 ],
180 "first_id": "first_id",
181 "has_more": true,
182 "last_id": "last_id",
183 "object": "list"
184}
185```
186
187## Get a specific skill version.
188
189`$ openai skills:versions retrieve`
190
191**get** `/skills/{skill_id}/versions/{version}`
192
193Get a specific skill version.
194
195### Parameters
196
197- `--skill-id: string`
198
199 The identifier of the skill.
200
201- `--version: string`
202
203 The version number to retrieve.
204
205### Returns
206
207- `skill_version: object { id, created_at, description, 4 more }`
208
209 - `id: string`
210
211 Unique identifier for the skill version.
212
213 - `created_at: number`
214
215 Unix timestamp (seconds) for when the version was created.
216
217 - `description: string`
218
219 Description of the skill version.
220
221 - `name: string`
222
223 Name of the skill version.
224
225 - `object: "skill.version"`
226
227 The object type, which is `skill.version`.
228
229 - `skill_id: string`
230
231 Identifier of the skill for this version.
232
233 - `version: string`
234
235 Version number for this skill.
236
237### Example
238
239```cli
240openai skills:versions retrieve \
241 --api-key 'My API Key' \
242 --skill-id skill_123 \
243 --version version
244```
245
246#### Response
247
248```json
249{
250 "id": "id",
251 "created_at": 0,
252 "description": "description",
253 "name": "name",
254 "object": "skill.version",
255 "skill_id": "skill_id",
256 "version": "version"
257}
258```
259
260## Delete a skill version.
261
262`$ openai skills:versions delete`
263
264**delete** `/skills/{skill_id}/versions/{version}`
265
266Delete a skill version.
267
268### Parameters
269
270- `--skill-id: string`
271
272 The identifier of the skill.
273
274- `--version: string`
275
276 The skill version number.
277
278### Returns
279
280- `deleted_skill_version: object { id, deleted, object, version }`
281
282 - `id: string`
283
284 - `deleted: boolean`
285
286 - `object: "skill.version.deleted"`
287
288 - `version: string`
289
290 The deleted skill version.
291
292### Example
293
294```cli
295openai skills:versions delete \
296 --api-key 'My API Key' \
297 --skill-id skill_123 \
298 --version version
299```
300
301#### Response
302
303```json
304{
305 "id": "id",
306 "deleted": true,
307 "object": "skill.version.deleted",
308 "version": "version"
309}
310```
311
312## Domain Types
313
314### Deleted Skill Version
315
316- `deleted_skill_version: object { id, deleted, object, version }`
317
318 - `id: string`
319
320 - `deleted: boolean`
321
322 - `object: "skill.version.deleted"`
323
324 - `version: string`
325
326 The deleted skill version.
327
328### Skill Version
329
330- `skill_version: object { id, created_at, description, 4 more }`
331
332 - `id: string`
333
334 Unique identifier for the skill version.
335
336 - `created_at: number`
337
338 Unix timestamp (seconds) for when the version was created.
339
340 - `description: string`
341
342 Description of the skill version.
343
344 - `name: string`
345
346 Name of the skill version.
347
348 - `object: "skill.version"`
349
350 The object type, which is `skill.version`.
351
352 - `skill_id: string`
353
354 Identifier of the skill for this version.
355
356 - `version: string`
357
358 Version number for this skill.
359
360### Skill Version List
361
362- `skill_version_list: object { data, first_id, has_more, 2 more }`
363
364 - `data: array of SkillVersion`
365
366 A list of items
367
368 - `id: string`
369
370 Unique identifier for the skill version.
371
372 - `created_at: number`
373
374 Unix timestamp (seconds) for when the version was created.
375
376 - `description: string`
377
378 Description of the skill version.
379
380 - `name: string`
381
382 Name of the skill version.
383
384 - `object: "skill.version"`
385
386 The object type, which is `skill.version`.
387
388 - `skill_id: string`
389
390 Identifier of the skill for this version.
391
392 - `version: string`
393
394 Version number for this skill.
395
396 - `first_id: string`
397
398 The ID of the first item in the list.
399
400 - `has_more: boolean`
401
402 Whether there are more items available.
403
404 - `last_id: string`
405
406 The ID of the last item in the list.
407
408 - `object: "list"`
409
410 The type of object returned, must be `list`.
411
412# Content
413
414## Download a skill version zip bundle.
415
416`$ openai skills:versions:content retrieve`
417
418**get** `/skills/{skill_id}/versions/{version}/content`
419
420Download a skill version zip bundle.
421
422### Parameters
423
424- `--skill-id: string`
425
426 The identifier of the skill.
427
428- `--version: string`
429
430 The skill version number.
431
432### Returns
433
434- `unnamed_schema_5: file path`
435
436### Example
437
438```cli
439openai skills:versions:content retrieve \
440 --api-key 'My API Key' \
441 --skill-id skill_123 \
442 --version version
443```