openai-oxide 0.11.2

Idiomatic Rust client for the OpenAI API — 1:1 parity with the official Python SDK
Documentation 
1
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
28
29
30
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

// Videos resource (Sora) — video generation, editing, extension, remix.
//
// OpenAI guide: <https://developers.openai.com/api/docs/guides/video-generation>
// API reference: <https://platform.openai.com/docs/api-reference/videos>

use crate::client::OpenAI;
use crate::error::OpenAIError;

/// Access video generation endpoints (Sora 2 / Sora 2 Pro).
///
/// API reference: <https://platform.openai.com/docs/api-reference/videos>
pub struct Videos<'a> {
    client: &'a OpenAI,
}

impl<'a> Videos<'a> {
    pub(crate) fn new(client: &'a OpenAI) -> Self {
        Self { client }
    }

    /// Create a video generation job.
    ///
    /// `POST /videos`
    pub async fn create(
        &self,
        body: &impl serde::Serialize,
    ) -> Result<serde_json::Value, OpenAIError> {
        self.client.post("/videos", body).await
    }

    /// List video generation jobs.
    ///
    /// `GET /videos`
    pub async fn list(&self) -> Result<serde_json::Value, OpenAIError> {
        self.client.get("/videos").await
    }

    /// Retrieve video metadata.
    ///
    /// `GET /videos/{video_id}`
    pub async fn retrieve(&self, video_id: &str) -> Result<serde_json::Value, OpenAIError> {
        self.client.get(&format!("/videos/{video_id}")).await
    }

    /// Delete a video.
    ///
    /// `DELETE /videos/{video_id}`
    pub async fn delete(&self, video_id: &str) -> Result<serde_json::Value, OpenAIError> {
        self.client.delete(&format!("/videos/{video_id}")).await
    }

    /// Download video content bytes.
    ///
    /// `GET /videos/{video_id}/content`
    pub async fn content(&self, video_id: &str) -> Result<bytes::Bytes, OpenAIError> {
        self.client
            .get_raw(&format!("/videos/{video_id}/content"))
            .await
    }

    /// Create a video edit (modify an existing video).
    ///
    /// `POST /videos/edits`
    pub async fn edit(
        &self,
        body: &impl serde::Serialize,
    ) -> Result<serde_json::Value, OpenAIError> {
        self.client.post("/videos/edits", body).await
    }

    /// Extend a video (generate continuation).
    ///
    /// `POST /videos/extensions`
    pub async fn extend(
        &self,
        body: &impl serde::Serialize,
    ) -> Result<serde_json::Value, OpenAIError> {
        self.client.post("/videos/extensions", body).await
    }

    /// Remix a video (re-generate with modifications).
    ///
    /// `POST /videos/{video_id}/remix`
    pub async fn remix(
        &self,
        video_id: &str,
        body: &impl serde::Serialize,
    ) -> Result<serde_json::Value, OpenAIError> {
        self.client
            .post(&format!("/videos/{video_id}/remix"), body)
            .await
    }

    /// Create a reusable video character.
    ///
    /// `POST /videos/characters`
    pub async fn create_character(
        &self,
        body: &impl serde::Serialize,
    ) -> Result<serde_json::Value, OpenAIError> {
        self.client.post("/videos/characters", body).await
    }

    /// Retrieve a video character.
    ///
    /// `GET /videos/characters/{character_id}`
    pub async fn retrieve_character(
        &self,
        character_id: &str,
    ) -> Result<serde_json::Value, OpenAIError> {
        self.client
            .get(&format!("/videos/characters/{character_id}"))
            .await
    }
}