openrouter-rs 0.11.1

A type-safe OpenRouter Rust 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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
use derive_builder::Builder;
use reqwest::Client as HttpClient;
use serde::{Deserialize, Serialize, Serializer, ser::SerializeMap};
use urlencoding::encode;

use crate::{
    error::OpenRouterError,
    strip_option_vec_setter,
    transport::{request as transport_request, response as transport_response},
    types::{ApiResponse, PaginationOptions},
};

#[derive(Serialize)]
struct ListByokKeysQuery {
    #[serde(skip_serializing_if = "Option::is_none")]
    offset: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    limit: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    workspace_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    provider: Option<String>,
}

/// Bring-your-own-key provider credential returned by `/byok`.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[non_exhaustive]
pub struct ByokKey {
    pub id: String,
    pub provider: String,
    pub workspace_id: String,
    pub label: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    pub disabled: bool,
    pub is_fallback: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allowed_models: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allowed_api_key_hashes: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allowed_user_ids: Option<Vec<String>>,
    pub sort_order: i64,
    pub created_at: String,
}

/// Paginated BYOK credential list response.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[non_exhaustive]
pub struct ByokKeyListResponse {
    pub data: Vec<ByokKey>,
    pub total_count: u64,
}

/// Request payload for creating a BYOK credential (`POST /byok`).
#[derive(Serialize, Deserialize, Debug, Clone, Builder)]
#[builder(build_fn(error = "OpenRouterError"))]
#[non_exhaustive]
pub struct CreateByokKeyRequest {
    #[builder(setter(into))]
    pub provider: String,
    #[builder(setter(into))]
    pub key: String,
    #[builder(setter(into, strip_option), default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[builder(setter(into, strip_option), default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub workspace_id: Option<String>,
    #[builder(setter(custom), default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allowed_models: Option<Vec<String>>,
    #[builder(setter(custom), default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allowed_user_ids: Option<Vec<String>>,
    #[builder(setter(strip_option), default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub disabled: Option<bool>,
    #[builder(setter(strip_option), default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub is_fallback: Option<bool>,
}

impl CreateByokKeyRequest {
    pub fn builder() -> CreateByokKeyRequestBuilder {
        CreateByokKeyRequestBuilder::default()
    }
}

impl CreateByokKeyRequestBuilder {
    strip_option_vec_setter!(allowed_models, String);
    strip_option_vec_setter!(allowed_user_ids, String);
}

/// Request payload for updating a BYOK credential (`PATCH /byok/{id}`).
#[derive(Deserialize, Debug, Clone, Builder)]
#[builder(build_fn(error = "OpenRouterError"))]
#[non_exhaustive]
pub struct UpdateByokKeyRequest {
    #[builder(setter(into, strip_option), default)]
    pub key: Option<String>,
    #[builder(setter(custom), default)]
    pub name: Option<String>,
    #[serde(skip)]
    #[builder(setter(custom), default)]
    clear_name: bool,
    #[builder(setter(custom), default)]
    pub allowed_models: Option<Vec<String>>,
    #[serde(skip)]
    #[builder(setter(custom), default)]
    clear_allowed_models: bool,
    #[builder(setter(custom), default)]
    pub allowed_user_ids: Option<Vec<String>>,
    #[serde(skip)]
    #[builder(setter(custom), default)]
    clear_allowed_user_ids: bool,
    #[builder(setter(strip_option), default)]
    pub disabled: Option<bool>,
    #[builder(setter(strip_option), default)]
    pub is_fallback: Option<bool>,
}

impl Serialize for UpdateByokKeyRequest {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut map = serializer.serialize_map(None)?;
        if let Some(value) = &self.key {
            map.serialize_entry("key", value)?;
        }
        if self.clear_name {
            map.serialize_entry("name", &Option::<String>::None)?;
        } else if let Some(value) = &self.name {
            map.serialize_entry("name", value)?;
        }
        if self.clear_allowed_models {
            map.serialize_entry("allowed_models", &Option::<Vec<String>>::None)?;
        } else if let Some(value) = &self.allowed_models {
            map.serialize_entry("allowed_models", value)?;
        }
        if self.clear_allowed_user_ids {
            map.serialize_entry("allowed_user_ids", &Option::<Vec<String>>::None)?;
        } else if let Some(value) = &self.allowed_user_ids {
            map.serialize_entry("allowed_user_ids", value)?;
        }
        if let Some(value) = &self.disabled {
            map.serialize_entry("disabled", value)?;
        }
        if let Some(value) = &self.is_fallback {
            map.serialize_entry("is_fallback", value)?;
        }
        map.end()
    }
}

impl UpdateByokKeyRequest {
    pub fn builder() -> UpdateByokKeyRequestBuilder {
        UpdateByokKeyRequestBuilder::default()
    }
}

impl UpdateByokKeyRequestBuilder {
    pub fn name(&mut self, value: impl Into<String>) -> &mut Self {
        self.name = Some(Some(value.into()));
        self.clear_name = Some(false);
        self
    }

    pub fn clear_name(&mut self) -> &mut Self {
        self.name = Some(None);
        self.clear_name = Some(true);
        self
    }

    pub fn allowed_models<T, S>(&mut self, items: T) -> &mut Self
    where
        T: IntoIterator<Item = S>,
        S: Into<String>,
    {
        self.allowed_models = Some(Some(items.into_iter().map(Into::into).collect()));
        self.clear_allowed_models = Some(false);
        self
    }

    pub fn allowed_user_ids<T, S>(&mut self, items: T) -> &mut Self
    where
        T: IntoIterator<Item = S>,
        S: Into<String>,
    {
        self.allowed_user_ids = Some(Some(items.into_iter().map(Into::into).collect()));
        self.clear_allowed_user_ids = Some(false);
        self
    }

    pub fn clear_allowed_models(&mut self) -> &mut Self {
        self.allowed_models = Some(None);
        self.clear_allowed_models = Some(true);
        self
    }

    pub fn clear_allowed_user_ids(&mut self) -> &mut Self {
        self.allowed_user_ids = Some(None);
        self.clear_allowed_user_ids = Some(true);
        self
    }
}

#[derive(Serialize, Deserialize, Debug, Clone)]
struct DeleteByokKeyResponse {
    deleted: bool,
}

/// List BYOK provider credentials (`GET /byok`). Requires a management key.
pub async fn list_byok_keys(
    base_url: &str,
    management_key: &str,
    pagination: Option<PaginationOptions>,
    workspace_id: Option<&str>,
    provider: Option<&str>,
) -> Result<ByokKeyListResponse, OpenRouterError> {
    let http_client = crate::transport::new_client()?;
    list_byok_keys_with_client(
        &http_client,
        base_url,
        management_key,
        pagination,
        workspace_id,
        provider,
    )
    .await
}

pub(crate) async fn list_byok_keys_with_client(
    http_client: &HttpClient,
    base_url: &str,
    management_key: &str,
    pagination: Option<PaginationOptions>,
    workspace_id: Option<&str>,
    provider: Option<&str>,
) -> Result<ByokKeyListResponse, OpenRouterError> {
    let url = format!("{base_url}/byok");
    let query = ListByokKeysQuery {
        offset: pagination.and_then(|p| p.offset),
        limit: pagination.and_then(|p| p.limit),
        workspace_id: workspace_id.map(ToOwned::to_owned),
        provider: provider.map(ToOwned::to_owned),
    };
    let req = transport_request::with_bearer_auth(
        transport_request::get(http_client, &url),
        management_key,
    );
    let response = if query.offset.is_none()
        && query.limit.is_none()
        && query.workspace_id.is_none()
        && query.provider.is_none()
    {
        req.send().await?
    } else {
        req.query(&query).send().await?
    };

    if response.status().is_success() {
        transport_response::parse_json_response(response, "BYOK key list").await
    } else {
        transport_response::handle_error(response).await?;
        unreachable!()
    }
}

/// Create a BYOK provider credential (`POST /byok`). Requires a management key.
pub async fn create_byok_key(
    base_url: &str,
    management_key: &str,
    request: &CreateByokKeyRequest,
) -> Result<ByokKey, OpenRouterError> {
    let http_client = crate::transport::new_client()?;
    create_byok_key_with_client(&http_client, base_url, management_key, request).await
}

pub(crate) async fn create_byok_key_with_client(
    http_client: &HttpClient,
    base_url: &str,
    management_key: &str,
    request: &CreateByokKeyRequest,
) -> Result<ByokKey, OpenRouterError> {
    let url = format!("{base_url}/byok");
    let response = transport_request::with_bearer_auth(
        transport_request::post(http_client, &url),
        management_key,
    )
    .json(request)
    .send()
    .await?;

    if response.status().is_success() {
        let payload: ApiResponse<ByokKey> =
            transport_response::parse_json_response(response, "BYOK key creation").await?;
        Ok(payload.data)
    } else {
        transport_response::handle_error(response).await?;
        unreachable!()
    }
}

/// Get a BYOK provider credential (`GET /byok/{id}`). Requires a management key.
pub async fn get_byok_key(
    base_url: &str,
    management_key: &str,
    id: &str,
) -> Result<ByokKey, OpenRouterError> {
    let http_client = crate::transport::new_client()?;
    get_byok_key_with_client(&http_client, base_url, management_key, id).await
}

pub(crate) async fn get_byok_key_with_client(
    http_client: &HttpClient,
    base_url: &str,
    management_key: &str,
    id: &str,
) -> Result<ByokKey, OpenRouterError> {
    let url = format!("{base_url}/byok/{}", encode(id));
    let response = transport_request::with_bearer_auth(
        transport_request::get(http_client, &url),
        management_key,
    )
    .send()
    .await?;

    if response.status().is_success() {
        let payload: ApiResponse<ByokKey> =
            transport_response::parse_json_response(response, "BYOK key lookup").await?;
        Ok(payload.data)
    } else {
        transport_response::handle_error(response).await?;
        unreachable!()
    }
}

/// Update a BYOK provider credential (`PATCH /byok/{id}`). Requires a management key.
pub async fn update_byok_key(
    base_url: &str,
    management_key: &str,
    id: &str,
    request: &UpdateByokKeyRequest,
) -> Result<ByokKey, OpenRouterError> {
    let http_client = crate::transport::new_client()?;
    update_byok_key_with_client(&http_client, base_url, management_key, id, request).await
}

pub(crate) async fn update_byok_key_with_client(
    http_client: &HttpClient,
    base_url: &str,
    management_key: &str,
    id: &str,
    request: &UpdateByokKeyRequest,
) -> Result<ByokKey, OpenRouterError> {
    let url = format!("{base_url}/byok/{}", encode(id));
    let response = transport_request::with_bearer_auth(
        transport_request::patch(http_client, &url),
        management_key,
    )
    .json(request)
    .send()
    .await?;

    if response.status().is_success() {
        let payload: ApiResponse<ByokKey> =
            transport_response::parse_json_response(response, "BYOK key update").await?;
        Ok(payload.data)
    } else {
        transport_response::handle_error(response).await?;
        unreachable!()
    }
}

/// Delete a BYOK provider credential (`DELETE /byok/{id}`). Requires a management key.
pub async fn delete_byok_key(
    base_url: &str,
    management_key: &str,
    id: &str,
) -> Result<bool, OpenRouterError> {
    let http_client = crate::transport::new_client()?;
    delete_byok_key_with_client(&http_client, base_url, management_key, id).await
}

pub(crate) async fn delete_byok_key_with_client(
    http_client: &HttpClient,
    base_url: &str,
    management_key: &str,
    id: &str,
) -> Result<bool, OpenRouterError> {
    let url = format!("{base_url}/byok/{}", encode(id));
    let response = transport_request::with_bearer_auth(
        transport_request::delete(http_client, &url),
        management_key,
    )
    .send()
    .await?;

    if response.status().is_success() {
        let payload: DeleteByokKeyResponse =
            transport_response::parse_json_response(response, "BYOK key deletion").await?;
        Ok(payload.deleted)
    } else {
        transport_response::handle_error(response).await?;
        unreachable!()
    }
}