cli/resources/videos/index.md +0 −1257 deleted
File Deleted View Diff
1# Videos
2
3## Create video
4
5`$ openai videos create`
6
7**post** `/videos`
8
9Create a new video generation job from a prompt and optional reference assets.
10
11### Parameters
12
13- `--prompt: string`
14
15 Text prompt that describes the video to generate.
16
17- `--input-reference: optional string or ImageInputReferenceParam`
18
19 Optional reference asset upload or reference object that guides generation.
20
21- `--model: optional string or "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more`
22
23 The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults to `sora-2`.
24
25- `--seconds: optional "4" or "8" or "12"`
26
27 Clip duration in seconds (allowed values: 4, 8, 12). Defaults to 4 seconds.
28
29- `--size: optional "720x1280" or "1280x720" or "1024x1792" or "1792x1024"`
30
31 Output resolution formatted as width x height (allowed values: 720x1280, 1280x720, 1024x1792, 1792x1024). Defaults to 720x1280.
32
33### Returns
34
35- `video: object { id, completed_at, created_at, 10 more }`
36
37 Structured information describing a generated video job.
38
39 - `id: string`
40
41 Unique identifier for the video job.
42
43 - `completed_at: number`
44
45 Unix timestamp (seconds) for when the job completed, if finished.
46
47 - `created_at: number`
48
49 Unix timestamp (seconds) for when the job was created.
50
51 - `error: object { code, message }`
52
53 Error payload that explains why generation failed, if applicable.
54
55 - `code: string`
56
57 A machine-readable error code that was returned.
58
59 - `message: string`
60
61 A human-readable description of the error that was returned.
62
63 - `expires_at: number`
64
65 Unix timestamp (seconds) for when the downloadable assets expire, if set.
66
67 - `model: string or "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more`
68
69 The video generation model that produced the job.
70
71 - `"sora-2"`
72
73 - `"sora-2-pro"`
74
75 - `"sora-2-2025-10-06"`
76
77 - `"sora-2-pro-2025-10-06"`
78
79 - `"sora-2-2025-12-08"`
80
81 - `object: "video"`
82
83 The object type, which is always `video`.
84
85 - `progress: number`
86
87 Approximate completion percentage for the generation task.
88
89 - `prompt: string`
90
91 The prompt that was used to generate the video.
92
93 - `remixed_from_video_id: string`
94
95 Identifier of the source video if this video is a remix.
96
97 - `seconds: string or VideoSeconds`
98
99 Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
100
101 - `"4"`
102
103 - `"8"`
104
105 - `"12"`
106
107 - `size: "720x1280" or "1280x720" or "1024x1792" or "1792x1024"`
108
109 The resolution of the generated video.
110
111 - `"720x1280"`
112
113 - `"1280x720"`
114
115 - `"1024x1792"`
116
117 - `"1792x1024"`
118
119 - `status: "queued" or "in_progress" or "completed" or "failed"`
120
121 Current lifecycle status of the video job.
122
123 - `"queued"`
124
125 - `"in_progress"`
126
127 - `"completed"`
128
129 - `"failed"`
130
131### Example
132
133```cli
134openai videos create \
135 --api-key 'My API Key' \
136 --prompt x
137```
138
139#### Response
140
141```json
142{
143 "id": "id",
144 "completed_at": 0,
145 "created_at": 0,
146 "error": {
147 "code": "code",
148 "message": "message"
149 },
150 "expires_at": 0,
151 "model": "string",
152 "object": "video",
153 "progress": 0,
154 "prompt": "prompt",
155 "remixed_from_video_id": "remixed_from_video_id",
156 "seconds": "string",
157 "size": "720x1280",
158 "status": "queued"
159}
160```
161
162## Create a new video generation job by editing a source video or existing generated video.
163
164`$ openai videos edit`
165
166**post** `/videos/edits`
167
168Create a new video generation job by editing a source video or existing generated video.
169
170### Parameters
171
172- `--prompt: string`
173
174 Text prompt that describes how to edit the source video.
175
176- `--video: string or object { id }`
177
178 Reference to the completed video to edit.
179
180### Returns
181
182- `video: object { id, completed_at, created_at, 10 more }`
183
184 Structured information describing a generated video job.
185
186 - `id: string`
187
188 Unique identifier for the video job.
189
190 - `completed_at: number`
191
192 Unix timestamp (seconds) for when the job completed, if finished.
193
194 - `created_at: number`
195
196 Unix timestamp (seconds) for when the job was created.
197
198 - `error: object { code, message }`
199
200 Error payload that explains why generation failed, if applicable.
201
202 - `code: string`
203
204 A machine-readable error code that was returned.
205
206 - `message: string`
207
208 A human-readable description of the error that was returned.
209
210 - `expires_at: number`
211
212 Unix timestamp (seconds) for when the downloadable assets expire, if set.
213
214 - `model: string or "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more`
215
216 The video generation model that produced the job.
217
218 - `"sora-2"`
219
220 - `"sora-2-pro"`
221
222 - `"sora-2-2025-10-06"`
223
224 - `"sora-2-pro-2025-10-06"`
225
226 - `"sora-2-2025-12-08"`
227
228 - `object: "video"`
229
230 The object type, which is always `video`.
231
232 - `progress: number`
233
234 Approximate completion percentage for the generation task.
235
236 - `prompt: string`
237
238 The prompt that was used to generate the video.
239
240 - `remixed_from_video_id: string`
241
242 Identifier of the source video if this video is a remix.
243
244 - `seconds: string or VideoSeconds`
245
246 Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
247
248 - `"4"`
249
250 - `"8"`
251
252 - `"12"`
253
254 - `size: "720x1280" or "1280x720" or "1024x1792" or "1792x1024"`
255
256 The resolution of the generated video.
257
258 - `"720x1280"`
259
260 - `"1280x720"`
261
262 - `"1024x1792"`
263
264 - `"1792x1024"`
265
266 - `status: "queued" or "in_progress" or "completed" or "failed"`
267
268 Current lifecycle status of the video job.
269
270 - `"queued"`
271
272 - `"in_progress"`
273
274 - `"completed"`
275
276 - `"failed"`
277
278### Example
279
280```cli
281openai videos edit \
282 --api-key 'My API Key' \
283 --prompt x \
284 --video 'Example data'
285```
286
287#### Response
288
289```json
290{
291 "id": "id",
292 "completed_at": 0,
293 "created_at": 0,
294 "error": {
295 "code": "code",
296 "message": "message"
297 },
298 "expires_at": 0,
299 "model": "string",
300 "object": "video",
301 "progress": 0,
302 "prompt": "prompt",
303 "remixed_from_video_id": "remixed_from_video_id",
304 "seconds": "string",
305 "size": "720x1280",
306 "status": "queued"
307}
308```
309
310## Create an extension of a completed video.
311
312`$ openai videos extend`
313
314**post** `/videos/extensions`
315
316Create an extension of a completed video.
317
318### Parameters
319
320- `--prompt: string`
321
322 Updated text prompt that directs the extension generation.
323
324- `--seconds: "4" or "8" or "12"`
325
326 Length of the newly generated extension segment in seconds (allowed values: 4, 8, 12, 16, 20).
327
328- `--video: string or object { id }`
329
330 Reference to the completed video to extend.
331
332### Returns
333
334- `video: object { id, completed_at, created_at, 10 more }`
335
336 Structured information describing a generated video job.
337
338 - `id: string`
339
340 Unique identifier for the video job.
341
342 - `completed_at: number`
343
344 Unix timestamp (seconds) for when the job completed, if finished.
345
346 - `created_at: number`
347
348 Unix timestamp (seconds) for when the job was created.
349
350 - `error: object { code, message }`
351
352 Error payload that explains why generation failed, if applicable.
353
354 - `code: string`
355
356 A machine-readable error code that was returned.
357
358 - `message: string`
359
360 A human-readable description of the error that was returned.
361
362 - `expires_at: number`
363
364 Unix timestamp (seconds) for when the downloadable assets expire, if set.
365
366 - `model: string or "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more`
367
368 The video generation model that produced the job.
369
370 - `"sora-2"`
371
372 - `"sora-2-pro"`
373
374 - `"sora-2-2025-10-06"`
375
376 - `"sora-2-pro-2025-10-06"`
377
378 - `"sora-2-2025-12-08"`
379
380 - `object: "video"`
381
382 The object type, which is always `video`.
383
384 - `progress: number`
385
386 Approximate completion percentage for the generation task.
387
388 - `prompt: string`
389
390 The prompt that was used to generate the video.
391
392 - `remixed_from_video_id: string`
393
394 Identifier of the source video if this video is a remix.
395
396 - `seconds: string or VideoSeconds`
397
398 Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
399
400 - `"4"`
401
402 - `"8"`
403
404 - `"12"`
405
406 - `size: "720x1280" or "1280x720" or "1024x1792" or "1792x1024"`
407
408 The resolution of the generated video.
409
410 - `"720x1280"`
411
412 - `"1280x720"`
413
414 - `"1024x1792"`
415
416 - `"1792x1024"`
417
418 - `status: "queued" or "in_progress" or "completed" or "failed"`
419
420 Current lifecycle status of the video job.
421
422 - `"queued"`
423
424 - `"in_progress"`
425
426 - `"completed"`
427
428 - `"failed"`
429
430### Example
431
432```cli
433openai videos extend \
434 --api-key 'My API Key' \
435 --prompt x \
436 --seconds 4 \
437 --video 'Example data'
438```
439
440#### Response
441
442```json
443{
444 "id": "id",
445 "completed_at": 0,
446 "created_at": 0,
447 "error": {
448 "code": "code",
449 "message": "message"
450 },
451 "expires_at": 0,
452 "model": "string",
453 "object": "video",
454 "progress": 0,
455 "prompt": "prompt",
456 "remixed_from_video_id": "remixed_from_video_id",
457 "seconds": "string",
458 "size": "720x1280",
459 "status": "queued"
460}
461```
462
463## Create a character from an uploaded video.
464
465`$ openai videos create-character`
466
467**post** `/videos/characters`
468
469Create a character from an uploaded video.
470
471### Parameters
472
473- `--name: string`
474
475 Display name for this API character.
476
477- `--video: string`
478
479 Video file used to create a character.
480
481### Returns
482
483- `VideoNewCharacterResponse: object { id, created_at, name }`
484
485 - `id: string`
486
487 Identifier for the character creation cameo.
488
489 - `created_at: number`
490
491 Unix timestamp (in seconds) when the character was created.
492
493 - `name: string`
494
495 Display name for the character.
496
497### Example
498
499```cli
500openai videos create-character \
501 --api-key 'My API Key' \
502 --name x \
503 --video 'Example data'
504```
505
506#### Response
507
508```json
509{
510 "id": "id",
511 "created_at": 0,
512 "name": "name"
513}
514```
515
516## Fetch a character.
517
518`$ openai videos get-character`
519
520**get** `/videos/characters/{character_id}`
521
522Fetch a character.
523
524### Parameters
525
526- `--character-id: string`
527
528 The identifier of the character to retrieve.
529
530### Returns
531
532- `VideoGetCharacterResponse: object { id, created_at, name }`
533
534 - `id: string`
535
536 Identifier for the character creation cameo.
537
538 - `created_at: number`
539
540 Unix timestamp (in seconds) when the character was created.
541
542 - `name: string`
543
544 Display name for the character.
545
546### Example
547
548```cli
549openai videos get-character \
550 --api-key 'My API Key' \
551 --character-id char_123
552```
553
554#### Response
555
556```json
557{
558 "id": "id",
559 "created_at": 0,
560 "name": "name"
561}
562```
563
564## List videos
565
566`$ openai videos list`
567
568**get** `/videos`
569
570List recently generated videos for the current project.
571
572### Parameters
573
574- `--after: optional string`
575
576 Identifier for the last item from the previous pagination request
577
578- `--limit: optional number`
579
580 Number of items to retrieve
581
582- `--order: optional "asc" or "desc"`
583
584 Sort order of results by timestamp. Use `asc` for ascending order or `desc` for descending order.
585
586### Returns
587
588- `VideoListResource: object { data, first_id, has_more, 2 more }`
589
590 - `data: array of Video`
591
592 A list of items
593
594 - `id: string`
595
596 Unique identifier for the video job.
597
598 - `completed_at: number`
599
600 Unix timestamp (seconds) for when the job completed, if finished.
601
602 - `created_at: number`
603
604 Unix timestamp (seconds) for when the job was created.
605
606 - `error: object { code, message }`
607
608 Error payload that explains why generation failed, if applicable.
609
610 - `code: string`
611
612 A machine-readable error code that was returned.
613
614 - `message: string`
615
616 A human-readable description of the error that was returned.
617
618 - `expires_at: number`
619
620 Unix timestamp (seconds) for when the downloadable assets expire, if set.
621
622 - `model: string or "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more`
623
624 The video generation model that produced the job.
625
626 - `"sora-2"`
627
628 - `"sora-2-pro"`
629
630 - `"sora-2-2025-10-06"`
631
632 - `"sora-2-pro-2025-10-06"`
633
634 - `"sora-2-2025-12-08"`
635
636 - `object: "video"`
637
638 The object type, which is always `video`.
639
640 - `progress: number`
641
642 Approximate completion percentage for the generation task.
643
644 - `prompt: string`
645
646 The prompt that was used to generate the video.
647
648 - `remixed_from_video_id: string`
649
650 Identifier of the source video if this video is a remix.
651
652 - `seconds: string or VideoSeconds`
653
654 Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
655
656 - `"4"`
657
658 - `"8"`
659
660 - `"12"`
661
662 - `size: "720x1280" or "1280x720" or "1024x1792" or "1792x1024"`
663
664 The resolution of the generated video.
665
666 - `"720x1280"`
667
668 - `"1280x720"`
669
670 - `"1024x1792"`
671
672 - `"1792x1024"`
673
674 - `status: "queued" or "in_progress" or "completed" or "failed"`
675
676 Current lifecycle status of the video job.
677
678 - `"queued"`
679
680 - `"in_progress"`
681
682 - `"completed"`
683
684 - `"failed"`
685
686 - `first_id: string`
687
688 The ID of the first item in the list.
689
690 - `has_more: boolean`
691
692 Whether there are more items available.
693
694 - `last_id: string`
695
696 The ID of the last item in the list.
697
698 - `object: "list"`
699
700 The type of object returned, must be `list`.
701
702### Example
703
704```cli
705openai videos list \
706 --api-key 'My API Key'
707```
708
709#### Response
710
711```json
712{
713 "data": [
714 {
715 "id": "id",
716 "completed_at": 0,
717 "created_at": 0,
718 "error": {
719 "code": "code",
720 "message": "message"
721 },
722 "expires_at": 0,
723 "model": "string",
724 "object": "video",
725 "progress": 0,
726 "prompt": "prompt",
727 "remixed_from_video_id": "remixed_from_video_id",
728 "seconds": "string",
729 "size": "720x1280",
730 "status": "queued"
731 }
732 ],
733 "first_id": "first_id",
734 "has_more": true,
735 "last_id": "last_id",
736 "object": "list"
737}
738```
739
740## Retrieve video
741
742`$ openai videos retrieve`
743
744**get** `/videos/{video_id}`
745
746Fetch the latest metadata for a generated video.
747
748### Parameters
749
750- `--video-id: string`
751
752 The identifier of the video to retrieve.
753
754### Returns
755
756- `video: object { id, completed_at, created_at, 10 more }`
757
758 Structured information describing a generated video job.
759
760 - `id: string`
761
762 Unique identifier for the video job.
763
764 - `completed_at: number`
765
766 Unix timestamp (seconds) for when the job completed, if finished.
767
768 - `created_at: number`
769
770 Unix timestamp (seconds) for when the job was created.
771
772 - `error: object { code, message }`
773
774 Error payload that explains why generation failed, if applicable.
775
776 - `code: string`
777
778 A machine-readable error code that was returned.
779
780 - `message: string`
781
782 A human-readable description of the error that was returned.
783
784 - `expires_at: number`
785
786 Unix timestamp (seconds) for when the downloadable assets expire, if set.
787
788 - `model: string or "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more`
789
790 The video generation model that produced the job.
791
792 - `"sora-2"`
793
794 - `"sora-2-pro"`
795
796 - `"sora-2-2025-10-06"`
797
798 - `"sora-2-pro-2025-10-06"`
799
800 - `"sora-2-2025-12-08"`
801
802 - `object: "video"`
803
804 The object type, which is always `video`.
805
806 - `progress: number`
807
808 Approximate completion percentage for the generation task.
809
810 - `prompt: string`
811
812 The prompt that was used to generate the video.
813
814 - `remixed_from_video_id: string`
815
816 Identifier of the source video if this video is a remix.
817
818 - `seconds: string or VideoSeconds`
819
820 Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
821
822 - `"4"`
823
824 - `"8"`
825
826 - `"12"`
827
828 - `size: "720x1280" or "1280x720" or "1024x1792" or "1792x1024"`
829
830 The resolution of the generated video.
831
832 - `"720x1280"`
833
834 - `"1280x720"`
835
836 - `"1024x1792"`
837
838 - `"1792x1024"`
839
840 - `status: "queued" or "in_progress" or "completed" or "failed"`
841
842 Current lifecycle status of the video job.
843
844 - `"queued"`
845
846 - `"in_progress"`
847
848 - `"completed"`
849
850 - `"failed"`
851
852### Example
853
854```cli
855openai videos retrieve \
856 --api-key 'My API Key' \
857 --video-id video_123
858```
859
860#### Response
861
862```json
863{
864 "id": "id",
865 "completed_at": 0,
866 "created_at": 0,
867 "error": {
868 "code": "code",
869 "message": "message"
870 },
871 "expires_at": 0,
872 "model": "string",
873 "object": "video",
874 "progress": 0,
875 "prompt": "prompt",
876 "remixed_from_video_id": "remixed_from_video_id",
877 "seconds": "string",
878 "size": "720x1280",
879 "status": "queued"
880}
881```
882
883## Delete video
884
885`$ openai videos delete`
886
887**delete** `/videos/{video_id}`
888
889Permanently delete a completed or failed video and its stored assets.
890
891### Parameters
892
893- `--video-id: string`
894
895 The identifier of the video to delete.
896
897### Returns
898
899- `VideoDeleteResponse: object { id, deleted, object }`
900
901 Confirmation payload returned after deleting a video.
902
903 - `id: string`
904
905 Identifier of the deleted video.
906
907 - `deleted: boolean`
908
909 Indicates that the video resource was deleted.
910
911 - `object: "video.deleted"`
912
913 The object type that signals the deletion response.
914
915### Example
916
917```cli
918openai videos delete \
919 --api-key 'My API Key' \
920 --video-id video_123
921```
922
923#### Response
924
925```json
926{
927 "id": "id",
928 "deleted": true,
929 "object": "video.deleted"
930}
931```
932
933## Remix video
934
935`$ openai videos remix`
936
937**post** `/videos/{video_id}/remix`
938
939Create a remix of a completed video using a refreshed prompt.
940
941### Parameters
942
943- `--video-id: string`
944
945 The identifier of the completed video to remix.
946
947- `--prompt: string`
948
949 Updated text prompt that directs the remix generation.
950
951### Returns
952
953- `video: object { id, completed_at, created_at, 10 more }`
954
955 Structured information describing a generated video job.
956
957 - `id: string`
958
959 Unique identifier for the video job.
960
961 - `completed_at: number`
962
963 Unix timestamp (seconds) for when the job completed, if finished.
964
965 - `created_at: number`
966
967 Unix timestamp (seconds) for when the job was created.
968
969 - `error: object { code, message }`
970
971 Error payload that explains why generation failed, if applicable.
972
973 - `code: string`
974
975 A machine-readable error code that was returned.
976
977 - `message: string`
978
979 A human-readable description of the error that was returned.
980
981 - `expires_at: number`
982
983 Unix timestamp (seconds) for when the downloadable assets expire, if set.
984
985 - `model: string or "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more`
986
987 The video generation model that produced the job.
988
989 - `"sora-2"`
990
991 - `"sora-2-pro"`
992
993 - `"sora-2-2025-10-06"`
994
995 - `"sora-2-pro-2025-10-06"`
996
997 - `"sora-2-2025-12-08"`
998
999 - `object: "video"`
1000
1001 The object type, which is always `video`.
1002
1003 - `progress: number`
1004
1005 Approximate completion percentage for the generation task.
1006
1007 - `prompt: string`
1008
1009 The prompt that was used to generate the video.
1010
1011 - `remixed_from_video_id: string`
1012
1013 Identifier of the source video if this video is a remix.
1014
1015 - `seconds: string or VideoSeconds`
1016
1017 Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
1018
1019 - `"4"`
1020
1021 - `"8"`
1022
1023 - `"12"`
1024
1025 - `size: "720x1280" or "1280x720" or "1024x1792" or "1792x1024"`
1026
1027 The resolution of the generated video.
1028
1029 - `"720x1280"`
1030
1031 - `"1280x720"`
1032
1033 - `"1024x1792"`
1034
1035 - `"1792x1024"`
1036
1037 - `status: "queued" or "in_progress" or "completed" or "failed"`
1038
1039 Current lifecycle status of the video job.
1040
1041 - `"queued"`
1042
1043 - `"in_progress"`
1044
1045 - `"completed"`
1046
1047 - `"failed"`
1048
1049### Example
1050
1051```cli
1052openai videos remix \
1053 --api-key 'My API Key' \
1054 --video-id video_123 \
1055 --prompt x
1056```
1057
1058#### Response
1059
1060```json
1061{
1062 "id": "id",
1063 "completed_at": 0,
1064 "created_at": 0,
1065 "error": {
1066 "code": "code",
1067 "message": "message"
1068 },
1069 "expires_at": 0,
1070 "model": "string",
1071 "object": "video",
1072 "progress": 0,
1073 "prompt": "prompt",
1074 "remixed_from_video_id": "remixed_from_video_id",
1075 "seconds": "string",
1076 "size": "720x1280",
1077 "status": "queued"
1078}
1079```
1080
1081## Retrieve video content
1082
1083`$ openai videos download-content`
1084
1085**get** `/videos/{video_id}/content`
1086
1087Download the generated video bytes or a derived preview asset.
1088
1089Streams the rendered video content for the specified video job.
1090
1091### Parameters
1092
1093- `--video-id: string`
1094
1095 The identifier of the video whose media to download.
1096
1097- `--variant: optional "video" or "thumbnail" or "spritesheet"`
1098
1099 Which downloadable asset to return. Defaults to the MP4 video.
1100
1101### Returns
1102
1103- `unnamed_schema_6: file path`
1104
1105### Example
1106
1107```cli
1108openai videos download-content \
1109 --api-key 'My API Key' \
1110 --video-id video_123
1111```
1112
1113## Domain Types
1114
1115### Image Input Reference Param
1116
1117- `image_input_reference_param: object { file_id, image_url }`
1118
1119 - `file_id: optional string`
1120
1121 - `image_url: optional string`
1122
1123 A fully qualified URL or base64-encoded data URL.
1124
1125### Video
1126
1127- `video: object { id, completed_at, created_at, 10 more }`
1128
1129 Structured information describing a generated video job.
1130
1131 - `id: string`
1132
1133 Unique identifier for the video job.
1134
1135 - `completed_at: number`
1136
1137 Unix timestamp (seconds) for when the job completed, if finished.
1138
1139 - `created_at: number`
1140
1141 Unix timestamp (seconds) for when the job was created.
1142
1143 - `error: object { code, message }`
1144
1145 Error payload that explains why generation failed, if applicable.
1146
1147 - `code: string`
1148
1149 A machine-readable error code that was returned.
1150
1151 - `message: string`
1152
1153 A human-readable description of the error that was returned.
1154
1155 - `expires_at: number`
1156
1157 Unix timestamp (seconds) for when the downloadable assets expire, if set.
1158
1159 - `model: string or "sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more`
1160
1161 The video generation model that produced the job.
1162
1163 - `"sora-2"`
1164
1165 - `"sora-2-pro"`
1166
1167 - `"sora-2-2025-10-06"`
1168
1169 - `"sora-2-pro-2025-10-06"`
1170
1171 - `"sora-2-2025-12-08"`
1172
1173 - `object: "video"`
1174
1175 The object type, which is always `video`.
1176
1177 - `progress: number`
1178
1179 Approximate completion percentage for the generation task.
1180
1181 - `prompt: string`
1182
1183 The prompt that was used to generate the video.
1184
1185 - `remixed_from_video_id: string`
1186
1187 Identifier of the source video if this video is a remix.
1188
1189 - `seconds: string or VideoSeconds`
1190
1191 Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
1192
1193 - `"4"`
1194
1195 - `"8"`
1196
1197 - `"12"`
1198
1199 - `size: "720x1280" or "1280x720" or "1024x1792" or "1792x1024"`
1200
1201 The resolution of the generated video.
1202
1203 - `"720x1280"`
1204
1205 - `"1280x720"`
1206
1207 - `"1024x1792"`
1208
1209 - `"1792x1024"`
1210
1211 - `status: "queued" or "in_progress" or "completed" or "failed"`
1212
1213 Current lifecycle status of the video job.
1214
1215 - `"queued"`
1216
1217 - `"in_progress"`
1218
1219 - `"completed"`
1220
1221 - `"failed"`
1222
1223### Video Create Error
1224
1225- `video_create_error: object { code, message }`
1226
1227 An error that occurred while generating the response.
1228
1229 - `code: string`
1230
1231 A machine-readable error code that was returned.
1232
1233 - `message: string`
1234
1235 A human-readable description of the error that was returned.
1236
1237### Video Seconds
1238
1239- `video_seconds: "4" or "8" or "12"`
1240
1241 - `"4"`
1242
1243 - `"8"`
1244
1245 - `"12"`
1246
1247### Video Size
1248
1249- `video_size: "720x1280" or "1280x720" or "1024x1792" or "1792x1024"`
1250
1251 - `"720x1280"`
1252
1253 - `"1280x720"`
1254
1255 - `"1024x1792"`
1256
1257 - `"1792x1024"`