@j-o-r/hello-dave 0.1.1 → 0.1.5

package/lib/API/openai.com/video.list.md

@@ -0,0 +1,201 @@
+## [List videos](https://developers.openai.com/api/reference/resources/videos/methods/list)
+
+**get** `/videos`
+
+List recently generated videos for the current project.
+
+### Query Parameters
+
+- `after: optional string`
+
+  Identifier for the last item from the previous pagination request
+
+- `limit: optional number`
+
+  Number of items to retrieve
+
+- `order: optional "asc" or "desc"`
+
+  Sort order of results by timestamp. Use `asc` for ascending order or `desc` for descending order.
+
+  - `"asc"`
+
+  - `"desc"`
+
+### Returns
+
+- `data: array of Video`
+
+  A list of items
+
+  - `id: string`
+
+    Unique identifier for the video job.
+
+  - `completed_at: number`
+
+    Unix timestamp (seconds) for when the job completed, if finished.
+
+  - `created_at: number`
+
+    Unix timestamp (seconds) for when the job was created.
+
+  - `error: VideoCreateError`
+
+    Error payload that explains why generation failed, if applicable.
+
+    - `code: string`
+
+      A machine-readable error code that was returned.
+
+    - `message: string`
+
+      A human-readable description of the error that was returned.
+
+  - `expires_at: number`
+
+    Unix timestamp (seconds) for when the downloadable assets expire, if set.
+
+  - `model: VideoModel`
+
+    The video generation model that produced the job.
+
+    - `string`
+
+    - `"sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more`
+
+      - `"sora-2"`
+
+      - `"sora-2-pro"`
+
+      - `"sora-2-2025-10-06"`
+
+      - `"sora-2-pro-2025-10-06"`
+
+      - `"sora-2-2025-12-08"`
+
+  - `object: "video"`
+
+    The object type, which is always `video`.
+
+    - `"video"`
+
+  - `progress: number`
+
+    Approximate completion percentage for the generation task.
+
+  - `prompt: string`
+
+    The prompt that was used to generate the video.
+
+  - `remixed_from_video_id: string`
+
+    Identifier of the source video if this video is a remix.
+
+  - `seconds: string`
+
+    Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
+
+  - `size: VideoSize`
+
+    The resolution of the generated video.
+
+    - `"720x1280"`
+
+    - `"1280x720"`
+
+    - `"1024x1792"`
+
+    - `"1792x1024"`
+
+  - `status: "queued" or "in_progress" or "completed" or "failed"`
+
+    Current lifecycle status of the video job.
+
+    - `"queued"`
+
+    - `"in_progress"`
+
+    - `"completed"`
+
+    - `"failed"`
+
+- `first_id: string`
+
+  The ID of the first item in the list.
+
+- `has_more: boolean`
+
+  Whether there are more items available.
+
+- `last_id: string`
+
+  The ID of the last item in the list.
+
+- `object: "list"`
+
+  The type of object returned, must be `list`.
+
+  - `"list"`
+
+### Example
+
+```http
+curl https://api.openai.com/v1/videos \
+    -H "Authorization: Bearer $OPENAI_API_KEY"
+```
+
+#### Response
+
+```json
+{
+  "data": [
+    {
+      "id": "id",
+      "completed_at": 0,
+      "created_at": 0,
+      "error": {
+        "code": "code",
+        "message": "message"
+      },
+      "expires_at": 0,
+      "model": "sora-2",
+      "object": "video",
+      "progress": 0,
+      "prompt": "prompt",
+      "remixed_from_video_id": "remixed_from_video_id",
+      "seconds": "seconds",
+      "size": "720x1280",
+      "status": "queued"
+    }
+  ],
+  "first_id": "first_id",
+  "has_more": true,
+  "last_id": "last_id",
+  "object": "list"
+}
+```
+
+### Example
+
+```http
+curl https://api.openai.com/v1/videos \
+  -H "Authorization: Bearer $OPENAI_API_KEY"
+```
+
+#### Response
+
+```json
+{
+  "data": [
+    {
+      "id": "video_123",
+      "object": "video",
+      "model": "sora-2",
+      "status": "completed"
+    }
+  ],
+  "object": "list"
+}
+```
+

package/lib/API/openai.com/video.remix.md

@@ -0,0 +1,175 @@
+## [Remix video](https://developers.openai.com/api/reference/resources/videos/methods/remix)
+
+**post** `/videos/{video_id}/remix`
+
+Create a remix of a completed video using a refreshed prompt.
+
+### Path Parameters
+
+- `video_id: string`
+
+### Body Parameters
+
+- `prompt: string`
+
+  Updated text prompt that directs the remix generation.
+
+### Returns
+
+- `Video object { id, completed_at, created_at, 10 more }`
+
+  Structured information describing a generated video job.
+
+  - `id: string`
+
+    Unique identifier for the video job.
+
+  - `completed_at: number`
+
+    Unix timestamp (seconds) for when the job completed, if finished.
+
+  - `created_at: number`
+
+    Unix timestamp (seconds) for when the job was created.
+
+  - `error: VideoCreateError`
+
+    Error payload that explains why generation failed, if applicable.
+
+    - `code: string`
+
+      A machine-readable error code that was returned.
+
+    - `message: string`
+
+      A human-readable description of the error that was returned.
+
+  - `expires_at: number`
+
+    Unix timestamp (seconds) for when the downloadable assets expire, if set.
+
+  - `model: VideoModel`
+
+    The video generation model that produced the job.
+
+    - `string`
+
+    - `"sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more`
+
+      - `"sora-2"`
+
+      - `"sora-2-pro"`
+
+      - `"sora-2-2025-10-06"`
+
+      - `"sora-2-pro-2025-10-06"`
+
+      - `"sora-2-2025-12-08"`
+
+  - `object: "video"`
+
+    The object type, which is always `video`.
+
+    - `"video"`
+
+  - `progress: number`
+
+    Approximate completion percentage for the generation task.
+
+  - `prompt: string`
+
+    The prompt that was used to generate the video.
+
+  - `remixed_from_video_id: string`
+
+    Identifier of the source video if this video is a remix.
+
+  - `seconds: string`
+
+    Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
+
+  - `size: VideoSize`
+
+    The resolution of the generated video.
+
+    - `"720x1280"`
+
+    - `"1280x720"`
+
+    - `"1024x1792"`
+
+    - `"1792x1024"`
+
+  - `status: "queued" or "in_progress" or "completed" or "failed"`
+
+    Current lifecycle status of the video job.
+
+    - `"queued"`
+
+    - `"in_progress"`
+
+    - `"completed"`
+
+    - `"failed"`
+
+### Example
+
+```http
+curl https://api.openai.com/v1/videos/$VIDEO_ID/remix \
+    -H 'Content-Type: application/json' \
+    -H "Authorization: Bearer $OPENAI_API_KEY" \
+    -d '{
+          "prompt": "x"
+        }'
+```
+
+#### Response
+
+```json
+{
+  "id": "id",
+  "completed_at": 0,
+  "created_at": 0,
+  "error": {
+    "code": "code",
+    "message": "message"
+  },
+  "expires_at": 0,
+  "model": "sora-2",
+  "object": "video",
+  "progress": 0,
+  "prompt": "prompt",
+  "remixed_from_video_id": "remixed_from_video_id",
+  "seconds": "seconds",
+  "size": "720x1280",
+  "status": "queued"
+}
+```
+
+### Example
+
+```http
+curl -X POST https://api.openai.com/v1/videos/video_123/remix \
+  -H "Authorization: Bearer $OPENAI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "prompt": "Extend the scene with the cat taking a bow to the cheering audience"
+  }'
+```
+
+#### Response
+
+```json
+{
+  "id": "video_456",
+  "object": "video",
+  "model": "sora-2",
+  "status": "queued",
+  "progress": 0,
+  "created_at": 1712698600,
+  "size": "720x1280",
+  "seconds": "8",
+  "remixed_from_video_id": "video_123"
+}
+```
+

package/lib/API/openai.com/video.retrieve.md

@@ -0,0 +1,139 @@
+## Retrieve video
+[source](https://developers.openai.com/api/reference/resources/videos/methods/retrieve)
+
+**get** `/videos/{video_id}`
+
+Fetch the latest metadata for a generated video.
+
+### Path Parameters
+
+- `video_id: string`
+
+### Returns
+
+- `Video object { id, completed_at, created_at, 10 more }`
+
+  Structured information describing a generated video job.
+
+  - `id: string`
+
+    Unique identifier for the video job.
+
+  - `completed_at: number`
+
+    Unix timestamp (seconds) for when the job completed, if finished.
+
+  - `created_at: number`
+
+    Unix timestamp (seconds) for when the job was created.
+
+  - `error: VideoCreateError`
+
+    Error payload that explains why generation failed, if applicable.
+
+    - `code: string`
+
+      A machine-readable error code that was returned.
+
+    - `message: string`
+
+      A human-readable description of the error that was returned.
+
+  - `expires_at: number`
+
+    Unix timestamp (seconds) for when the downloadable assets expire, if set.
+
+  - `model: VideoModel`
+
+    The video generation model that produced the job.
+
+    - `string`
+
+    - `"sora-2" or "sora-2-pro" or "sora-2-2025-10-06" or 2 more`
+
+      - `"sora-2"`
+
+      - `"sora-2-pro"`
+
+      - `"sora-2-2025-10-06"`
+
+      - `"sora-2-pro-2025-10-06"`
+
+      - `"sora-2-2025-12-08"`
+
+  - `object: "video"`
+
+    The object type, which is always `video`.
+
+    - `"video"`
+
+  - `progress: number`
+
+    Approximate completion percentage for the generation task.
+
+  - `prompt: string`
+
+    The prompt that was used to generate the video.
+
+  - `remixed_from_video_id: string`
+
+    Identifier of the source video if this video is a remix.
+
+  - `seconds: string`
+
+    Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
+
+  - `size: VideoSize`
+
+    The resolution of the generated video.
+
+    - `"720x1280"`
+
+    - `"1280x720"`
+
+    - `"1024x1792"`
+
+    - `"1792x1024"`
+
+  - `status: "queued" or "in_progress" or "completed" or "failed"`
+
+    Current lifecycle status of the video job.
+
+    - `"queued"`
+
+    - `"in_progress"`
+
+    - `"completed"`
+
+    - `"failed"`
+
+### Example
+
+```http
+curl https://api.openai.com/v1/videos/$VIDEO_ID \
+    -H "Authorization: Bearer $OPENAI_API_KEY"
+```
+
+#### Response
+
+```json
+{
+  "id": "id",
+  "completed_at": 0,
+  "created_at": 0,
+  "error": {
+    "code": "code",
+    "message": "message"
+  },
+  "expires_at": 0,
+  "model": "sora-2",
+  "object": "video",
+  "progress": 0,
+  "prompt": "prompt",
+  "remixed_from_video_id": "remixed_from_video_id",
+  "seconds": "seconds",
+  "size": "720x1280",
+  "status": "queued"
+}
+```
+