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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
use derive_builder::Builder;
use futures_util::stream::BoxStream;
#[cfg(feature = "legacy-completions")]
use crate::api::legacy::completion;
use crate::{
api::{
api_keys, auth, chat, credits, discovery, embeddings, generation, guardrails, messages,
models, responses,
},
config::OpenRouterConfig,
error::OpenRouterError,
types::{
ModelCategory, PaginationOptions, SupportedParameters,
completion::CompletionsResponse,
stream::{
ToolAwareStream, UnifiedStream, adapt_chat_stream, adapt_messages_stream,
adapt_responses_stream,
},
},
};
#[derive(Debug, Clone, Builder)]
#[builder(build_fn(error = "OpenRouterError"))]
pub struct OpenRouterClient {
#[builder(
setter(into),
default = "String::from(\"https://openrouter.ai/api/v1\")"
)]
base_url: String,
#[builder(setter(into, strip_option), default)]
api_key: Option<String>,
#[builder(setter(into, strip_option), default)]
management_key: Option<String>,
#[builder(setter(into, strip_option), default)]
http_referer: Option<String>,
#[builder(setter(into, strip_option), default)]
x_title: Option<String>,
#[builder(setter(into, strip_option), default)]
config: Option<OpenRouterConfig>,
}
fn legacy_offset_to_pagination(offset: Option<f64>) -> Option<PaginationOptions> {
offset.and_then(|value| {
if value.is_finite() && value >= 0.0 {
Some(PaginationOptions::with_offset(value.trunc() as u32))
} else {
None
}
})
}
impl OpenRouterClientBuilder {
#[deprecated(
since = "0.5.2",
note = "renamed to management_key(...); provisioning_key(...) will be removed in 0.6.0"
)]
pub fn provisioning_key(&mut self, provisioning_key: impl Into<String>) -> &mut Self {
self.management_key(provisioning_key)
}
}
impl OpenRouterClient {
pub fn builder() -> OpenRouterClientBuilder {
OpenRouterClientBuilder::default()
}
pub fn get_config(&self) -> Option<OpenRouterConfig> {
self.config.clone()
}
/// Sets the API key after client construction.
///
/// # Arguments
///
/// * `api_key` - The API key to set
///
/// # Example
///
/// ```
/// let mut client = OpenRouterClient::builder().build();
/// client.set_api_key("your_api_key");
/// ```
pub fn set_api_key(&mut self, api_key: impl Into<String>) {
self.api_key = Some(api_key.into());
}
/// Clears the currently set API key.
///
/// # Example
///
/// ```
/// let mut client = OpenRouterClient::builder().api_key("your_api_key").build();
/// client.clear_api_key();
/// ```
pub fn clear_api_key(&mut self) {
self.api_key = None;
}
/// Sets the management key after client construction.
///
/// # Arguments
///
/// * `management_key` - The management key to set
///
/// # Example
///
/// ```
/// let mut client = OpenRouterClient::builder().build();
/// client.set_management_key("your_management_key");
/// ```
pub fn set_management_key(&mut self, management_key: impl Into<String>) {
self.management_key = Some(management_key.into());
}
/// Clears the currently set management key.
///
/// # Example
///
/// ```
/// let mut client = OpenRouterClient::builder().build();
/// client.set_management_key("your_management_key");
/// client.clear_management_key();
/// ```
pub fn clear_management_key(&mut self) {
self.management_key = None;
}
#[deprecated(
since = "0.5.2",
note = "renamed to set_management_key(...); set_provisioning_key(...) will be removed in 0.6.0"
)]
pub fn set_provisioning_key(&mut self, provisioning_key: impl Into<String>) {
self.set_management_key(provisioning_key);
}
#[deprecated(
since = "0.5.2",
note = "renamed to clear_management_key(); clear_provisioning_key() will be removed in 0.6.0"
)]
pub fn clear_provisioning_key(&mut self) {
self.clear_management_key();
}
/// Domain client for chat completions and chat streaming.
pub fn chat(&self) -> ChatClient<'_> {
ChatClient { client: self }
}
/// Domain client for Responses API operations.
pub fn responses(&self) -> ResponsesClient<'_> {
ResponsesClient { client: self }
}
/// Domain client for Anthropic-compatible `/messages` operations.
pub fn messages(&self) -> MessagesClient<'_> {
MessagesClient { client: self }
}
/// Domain client for model/discovery/embedding operations.
pub fn models(&self) -> ModelsClient<'_> {
ModelsClient { client: self }
}
/// Domain client for management-governed endpoints.
pub fn management(&self) -> ManagementClient<'_> {
ManagementClient { client: self }
}
/// Domain client for legacy endpoint access (`legacy-completions` feature).
#[cfg(feature = "legacy-completions")]
pub fn legacy(&self) -> LegacyClient<'_> {
LegacyClient { client: self }
}
}
#[doc(hidden)]
impl OpenRouterClient {
/// Creates a new API key. Requires a management API key.
///
/// # Arguments
///
/// * `name` - The display name for the new API key.
/// * `limit` - Optional credit limit for the new API key.
///
/// # Returns
///
/// * `Result<api_keys::ApiKey, OpenRouterError>` - The created API key.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().management_key("your_management_key").build();
/// let api_key = client.create_api_key("New API Key", Some(100.0)).await?;
/// println!("{:?}", api_key);
/// ```
pub async fn create_api_key(
&self,
name: &str,
limit: Option<f64>,
) -> Result<api_keys::ApiKey, OpenRouterError> {
if let Some(management_key) = &self.management_key {
api_keys::create_api_key(&self.base_url, management_key, name, limit).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Get information on the API key associated with the current authentication session.
///
/// # Returns
///
/// * `Result<api_keys::ApiKeyDetails, OpenRouterError>` - The details of the current API key.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().api_key("your_api_key").build();
/// let api_key_details = client.get_current_api_key_info().await?;
/// println!("{:?}", api_key_details);
/// ```
pub async fn get_current_api_key_info(
&self,
) -> Result<api_keys::ApiKeyDetails, OpenRouterError> {
if let Some(api_key) = &self.api_key {
api_keys::get_current_api_key(&self.base_url, api_key).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Deletes an API key. Requires a management API key.
///
/// # Arguments
///
/// * `hash` - The hash of the API key to delete.
///
/// # Returns
///
/// * `Result<bool, OpenRouterError>` - A boolean indicating whether the deletion was successful.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().management_key("your_management_key").build();
/// let success = client.delete_api_key("api_key_hash").await?;
/// println!("Deletion successful: {}", success);
/// ```
pub async fn delete_api_key(&self, hash: &str) -> Result<bool, OpenRouterError> {
if let Some(management_key) = &self.management_key {
api_keys::delete_api_key(&self.base_url, management_key, hash).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Updates an existing API key. Requires a management API key.
///
/// # Arguments
///
/// * `hash` - The hash of the API key to update.
/// * `name` - Optional new display name for the API key.
/// * `disabled` - Optional flag to disable the API key.
/// * `limit` - Optional new credit limit for the API key.
///
/// # Returns
///
/// * `Result<api_keys::ApiKey, OpenRouterError>` - The updated API key.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().management_key("your_management_key").build();
/// let updated_api_key = client.update_api_key("api_key_hash", Some("Updated Name".to_string()), Some(false), Some(200.0)).await?;
/// println!("{:?}", updated_api_key);
/// ```
pub async fn update_api_key(
&self,
hash: &str,
name: Option<String>,
disabled: Option<bool>,
limit: Option<f64>,
) -> Result<api_keys::ApiKey, OpenRouterError> {
if let Some(management_key) = &self.management_key {
api_keys::update_api_key(&self.base_url, management_key, hash, name, disabled, limit)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
async fn list_api_keys_paginated(
&self,
pagination: Option<PaginationOptions>,
include_disabled: Option<bool>,
) -> Result<Vec<api_keys::ApiKey>, OpenRouterError> {
if let Some(management_key) = &self.management_key {
api_keys::list_api_keys(&self.base_url, management_key, pagination, include_disabled)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Returns a list of all API keys associated with the account. Requires a management API key.
///
/// # Arguments
///
/// * `offset` - Optional legacy offset value for the API keys list.
/// * `include_disabled` - Optional flag to include disabled API keys.
///
/// # Returns
///
/// * `Result<Vec<api_keys::ApiKey>, OpenRouterError>` - A list of API keys.
///
/// # Example
///
/// ```
/// # use openrouter_rs::OpenRouterClient;
/// let client = OpenRouterClient::builder().management_key("your_management_key").build()?;
/// let api_keys = client.list_api_keys(Some(0.0), Some(true)).await?;
/// println!("{:?}", api_keys);
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
#[deprecated(
since = "0.5.2",
note = "use client.management().list_api_keys(Some(PaginationOptions::with_offset(...)), include_disabled) for the 0.6-style API"
)]
pub async fn list_api_keys(
&self,
offset: Option<f64>,
include_disabled: Option<bool>,
) -> Result<Vec<api_keys::ApiKey>, OpenRouterError> {
self.list_api_keys_paginated(legacy_offset_to_pagination(offset), include_disabled)
.await
}
/// Returns details about a specific API key. Requires a management API key.
///
/// # Arguments
///
/// * `hash` - The hash of the API key to retrieve.
///
/// # Returns
///
/// * `Result<api_keys::ApiKey, OpenRouterError>` - The details of the specified API key.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().management_key("your_management_key").build();
/// let api_key = client.get_api_key("api_key_hash").await?;
/// println!("{:?}", api_key);
/// ```
pub async fn get_api_key(&self, hash: &str) -> Result<api_keys::ApiKey, OpenRouterError> {
if let Some(management_key) = &self.management_key {
api_keys::get_api_key(&self.base_url, management_key, hash).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Create an authorization code for PKCE flow (`POST /auth/keys/code`).
///
/// # Arguments
///
/// * `request` - The auth-code creation request built with `CreateAuthCodeRequest::builder()`.
///
/// # Returns
///
/// * `Result<auth::AuthCodeData, OpenRouterError>` - The created authorization code payload.
///
/// # Example
///
/// ```no_run
/// # use openrouter_rs::{OpenRouterClient, api::auth};
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let client = OpenRouterClient::builder().api_key("your_api_key").build()?;
///
/// let create = auth::CreateAuthCodeRequest::builder()
/// .callback_url("https://myapp.com/auth/callback")
/// .code_challenge("E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM")
/// .code_challenge_method(auth::CodeChallengeMethod::S256)
/// .build()?;
///
/// let auth_code = client.create_auth_code(&create).await?;
///
/// let exchanged = client
/// .exchange_code_for_api_key(
/// &auth_code.id,
/// Some("your_pkce_code_verifier"),
/// Some(auth::CodeChallengeMethod::S256),
/// )
/// .await?;
///
/// println!("New key: {}", exchanged.key);
/// # Ok(())
/// # }
/// ```
pub async fn create_auth_code(
&self,
request: &auth::CreateAuthCodeRequest,
) -> Result<auth::AuthCodeData, OpenRouterError> {
if let Some(api_key) = &self.api_key {
auth::create_auth_code(&self.base_url, api_key, request).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// List guardrails (`GET /guardrails`). Requires a management key.
pub async fn list_guardrails(
&self,
pagination: Option<PaginationOptions>,
) -> Result<guardrails::GuardrailListResponse, OpenRouterError> {
if let Some(management_key) = &self.management_key {
guardrails::list_guardrails(&self.base_url, management_key, pagination).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Create a guardrail (`POST /guardrails`). Requires a management key.
pub async fn create_guardrail(
&self,
request: &guardrails::CreateGuardrailRequest,
) -> Result<guardrails::Guardrail, OpenRouterError> {
if let Some(management_key) = &self.management_key {
guardrails::create_guardrail(&self.base_url, management_key, request).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Get a guardrail by ID (`GET /guardrails/{id}`). Requires a management key.
pub async fn get_guardrail(&self, id: &str) -> Result<guardrails::Guardrail, OpenRouterError> {
if let Some(management_key) = &self.management_key {
guardrails::get_guardrail(&self.base_url, management_key, id).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Update a guardrail (`PATCH /guardrails/{id}`). Requires a management key.
pub async fn update_guardrail(
&self,
id: &str,
request: &guardrails::UpdateGuardrailRequest,
) -> Result<guardrails::Guardrail, OpenRouterError> {
if let Some(management_key) = &self.management_key {
guardrails::update_guardrail(&self.base_url, management_key, id, request).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Delete a guardrail (`DELETE /guardrails/{id}`). Requires a management key.
pub async fn delete_guardrail(&self, id: &str) -> Result<bool, OpenRouterError> {
if let Some(management_key) = &self.management_key {
guardrails::delete_guardrail(&self.base_url, management_key, id).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// List key assignments for a guardrail (`GET /guardrails/{id}/assignments/keys`).
pub async fn list_guardrail_key_assignments(
&self,
id: &str,
pagination: Option<PaginationOptions>,
) -> Result<guardrails::GuardrailKeyAssignmentsResponse, OpenRouterError> {
if let Some(management_key) = &self.management_key {
guardrails::list_guardrail_key_assignments(
&self.base_url,
management_key,
id,
pagination,
)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Bulk assign key hashes to a guardrail (`POST /guardrails/{id}/assignments/keys`).
pub async fn bulk_assign_keys_to_guardrail(
&self,
id: &str,
request: &guardrails::BulkKeyAssignmentRequest,
) -> Result<guardrails::AssignedCountResponse, OpenRouterError> {
if let Some(management_key) = &self.management_key {
guardrails::bulk_assign_keys_to_guardrail(&self.base_url, management_key, id, request)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Bulk unassign key hashes from a guardrail (`POST /guardrails/{id}/assignments/keys/remove`).
pub async fn bulk_unassign_keys_from_guardrail(
&self,
id: &str,
request: &guardrails::BulkKeyAssignmentRequest,
) -> Result<guardrails::UnassignedCountResponse, OpenRouterError> {
if let Some(management_key) = &self.management_key {
guardrails::bulk_unassign_keys_from_guardrail(
&self.base_url,
management_key,
id,
request,
)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// List member assignments for a guardrail (`GET /guardrails/{id}/assignments/members`).
pub async fn list_guardrail_member_assignments(
&self,
id: &str,
pagination: Option<PaginationOptions>,
) -> Result<guardrails::GuardrailMemberAssignmentsResponse, OpenRouterError> {
if let Some(management_key) = &self.management_key {
guardrails::list_guardrail_member_assignments(
&self.base_url,
management_key,
id,
pagination,
)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Bulk assign members to a guardrail (`POST /guardrails/{id}/assignments/members`).
pub async fn bulk_assign_members_to_guardrail(
&self,
id: &str,
request: &guardrails::BulkMemberAssignmentRequest,
) -> Result<guardrails::AssignedCountResponse, OpenRouterError> {
if let Some(management_key) = &self.management_key {
guardrails::bulk_assign_members_to_guardrail(
&self.base_url,
management_key,
id,
request,
)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Bulk unassign members from a guardrail (`POST /guardrails/{id}/assignments/members/remove`).
pub async fn bulk_unassign_members_from_guardrail(
&self,
id: &str,
request: &guardrails::BulkMemberAssignmentRequest,
) -> Result<guardrails::UnassignedCountResponse, OpenRouterError> {
if let Some(management_key) = &self.management_key {
guardrails::bulk_unassign_members_from_guardrail(
&self.base_url,
management_key,
id,
request,
)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// List all key assignments (`GET /guardrails/assignments/keys`). Requires a management key.
pub async fn list_key_assignments(
&self,
pagination: Option<PaginationOptions>,
) -> Result<guardrails::GuardrailKeyAssignmentsResponse, OpenRouterError> {
if let Some(management_key) = &self.management_key {
guardrails::list_key_assignments(&self.base_url, management_key, pagination).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// List all member assignments (`GET /guardrails/assignments/members`). Requires a management key.
pub async fn list_member_assignments(
&self,
pagination: Option<PaginationOptions>,
) -> Result<guardrails::GuardrailMemberAssignmentsResponse, OpenRouterError> {
if let Some(management_key) = &self.management_key {
guardrails::list_member_assignments(&self.base_url, management_key, pagination).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Exchange an authorization code from the PKCE flow for a user-controlled API key.
///
/// # Arguments
///
/// * `code` - The authorization code received from the OAuth redirect.
/// * `code_verifier` - The code verifier if code_challenge was used in the authorization request.
/// * `code_challenge_method` - The method used to generate the code challenge.
///
/// # Returns
///
/// * `Result<auth::AuthResponse, OpenRouterError>` - The API key and user ID associated with the API key.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().api_key("your_api_key").build();
/// let auth_response = client.exchange_code_for_api_key("auth_code", Some("code_verifier"), Some(auth::CodeChallengeMethod::S256)).await?;
/// println!("{:?}", auth_response);
/// ```
pub async fn exchange_code_for_api_key(
&self,
code: &str,
code_verifier: Option<&str>,
code_challenge_method: Option<auth::CodeChallengeMethod>,
) -> Result<auth::AuthResponse, OpenRouterError> {
auth::exchange_code_for_api_key(&self.base_url, code, code_verifier, code_challenge_method)
.await
}
/// Send a chat completion request to a selected model.
///
/// # Arguments
///
/// * `request` - The chat completion request built using ChatCompletionRequest::builder().
///
/// # Returns
///
/// * `Result<chat::ChatCompletionResponse, OpenRouterError>` - The response from the chat completion request.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().api_key("your_api_key").build();
/// let request = chat::ChatCompletionRequest::builder()
/// .model("deepseek/deepseek-chat-v3-0324:free")
/// .messages(vec![chat::Message::new(chat::Role::User, "What is the meaning of life?")])
/// .max_tokens(100)
/// .temperature(0.7)
/// .build()?;
/// let response = client.send_chat_completion(&request).await?;
/// println!("{:?}", response);
/// ```
pub async fn send_chat_completion(
&self,
request: &chat::ChatCompletionRequest,
) -> Result<CompletionsResponse, OpenRouterError> {
if let Some(api_key) = &self.api_key {
chat::send_chat_completion(
&self.base_url,
api_key,
&self.x_title,
&self.http_referer,
request,
)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Streams chat completion events from a selected model.
///
/// # Arguments
///
/// * `request` - The chat completion request built using ChatCompletionRequest::builder().
///
/// # Returns
///
/// * `Result<BoxStream<'static, Result<CompletionsResponse, OpenRouterError>>, OpenRouterError>` - A stream of chat completion events or an error.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().api_key("your_api_key").build();
/// let request = chat::ChatCompletionRequest::builder()
/// .model("deepseek/deepseek-chat-v3-0324:free")
/// .messages(vec![chat::Message::new(chat::Role::User, "Tell me a joke.")])
/// .max_tokens(50)
/// .temperature(0.5)
/// .build()?;
/// let mut stream = client.stream_chat_completion(&request).await?;
/// while let Some(event) = stream.next().await {
/// match event {
/// Ok(event) => println!("{:?}", event),
/// Err(e) => eprintln!("Error: {:?}", e),
/// }
/// }
/// ```
pub async fn stream_chat_completion(
&self,
request: &chat::ChatCompletionRequest,
) -> Result<BoxStream<'static, Result<CompletionsResponse, OpenRouterError>>, OpenRouterError>
{
if let Some(api_key) = &self.api_key {
chat::stream_chat_completion(&self.base_url, api_key, request).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Streams chat completion events with tool-call-aware processing.
///
/// Returns a [`ToolAwareStream`] that yields [`StreamEvent`](crate::types::stream::StreamEvent)
/// values. Content and reasoning deltas are forwarded immediately, while
/// tool call fragments are accumulated internally and emitted as complete
/// [`ToolCall`](crate::types::completion::ToolCall) objects in the final
/// [`StreamEvent::Done`](crate::types::stream::StreamEvent::Done) event.
///
/// This is the recommended way to stream responses when using tool calling.
///
/// # Arguments
///
/// * `request` - The chat completion request (should include tools).
///
/// # Returns
///
/// * `Result<ToolAwareStream, OpenRouterError>` - A stream of [`StreamEvent`](crate::types::stream::StreamEvent) values.
///
/// # Example
///
/// ```no_run
/// use futures_util::StreamExt;
/// use openrouter_rs::types::stream::StreamEvent;
///
/// # async fn example(client: openrouter_rs::OpenRouterClient, request: openrouter_rs::api::chat::ChatCompletionRequest) -> Result<(), Box<dyn std::error::Error>> {
/// let mut stream = client.stream_chat_completion_tool_aware(&request).await?;
///
/// while let Some(event) = stream.next().await {
/// match event {
/// StreamEvent::ContentDelta(text) => print!("{}", text),
/// StreamEvent::Done { tool_calls, .. } => {
/// for tc in &tool_calls {
/// println!("Tool call: {}", tc.name());
/// }
/// },
/// _ => {}
/// }
/// }
/// # Ok(())
/// # }
/// ```
pub async fn stream_chat_completion_tool_aware(
&self,
request: &chat::ChatCompletionRequest,
) -> Result<ToolAwareStream, OpenRouterError> {
let raw_stream = self.stream_chat_completion(request).await?;
Ok(ToolAwareStream::new(raw_stream))
}
/// Stream chat completion events through the unified stream abstraction.
pub async fn stream_chat_completion_unified(
&self,
request: &chat::ChatCompletionRequest,
) -> Result<UnifiedStream, OpenRouterError> {
let raw_stream = self.stream_chat_completion(request).await?;
Ok(adapt_chat_stream(raw_stream))
}
/// Create a non-streaming response using the OpenRouter Responses API.
///
/// # Arguments
///
/// * `request` - The responses request built using `ResponsesRequest::builder()`.
///
/// # Returns
///
/// * `Result<responses::ResponsesResponse, OpenRouterError>` - The response payload.
pub async fn create_response(
&self,
request: &responses::ResponsesRequest,
) -> Result<responses::ResponsesResponse, OpenRouterError> {
if let Some(api_key) = &self.api_key {
responses::create_response(
&self.base_url,
api_key,
&self.x_title,
&self.http_referer,
request,
)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Stream response events from the OpenRouter Responses API.
///
/// # Arguments
///
/// * `request` - The responses request built using `ResponsesRequest::builder()`.
///
/// # Returns
///
/// * `Result<BoxStream<'static, Result<responses::ResponsesStreamEvent, OpenRouterError>>, OpenRouterError>` - A stream of response events.
pub async fn stream_response(
&self,
request: &responses::ResponsesRequest,
) -> Result<
BoxStream<'static, Result<responses::ResponsesStreamEvent, OpenRouterError>>,
OpenRouterError,
> {
if let Some(api_key) = &self.api_key {
responses::stream_response(
&self.base_url,
api_key,
&self.x_title,
&self.http_referer,
request,
)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Stream Responses API events through the unified stream abstraction.
pub async fn stream_response_unified(
&self,
request: &responses::ResponsesRequest,
) -> Result<UnifiedStream, OpenRouterError> {
let raw_stream = self.stream_response(request).await?;
Ok(adapt_responses_stream(raw_stream))
}
/// Create a non-streaming message using the Anthropic-compatible `/messages` API.
pub async fn create_message(
&self,
request: &messages::AnthropicMessagesRequest,
) -> Result<messages::AnthropicMessagesResponse, OpenRouterError> {
if let Some(api_key) = &self.api_key {
messages::create_message(
&self.base_url,
api_key,
&self.x_title,
&self.http_referer,
request,
)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Stream SSE events from the Anthropic-compatible `/messages` API.
pub async fn stream_messages(
&self,
request: &messages::AnthropicMessagesRequest,
) -> Result<
BoxStream<'static, Result<messages::AnthropicMessagesSseEvent, OpenRouterError>>,
OpenRouterError,
> {
if let Some(api_key) = &self.api_key {
messages::stream_messages(
&self.base_url,
api_key,
&self.x_title,
&self.http_referer,
request,
)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Stream Messages API events through the unified stream abstraction.
pub async fn stream_messages_unified(
&self,
request: &messages::AnthropicMessagesRequest,
) -> Result<UnifiedStream, OpenRouterError> {
let raw_stream = self.stream_messages(request).await?;
Ok(adapt_messages_stream(raw_stream))
}
/// Send a legacy completion request to a selected model (text-only format).
///
/// # Arguments
///
/// * `request` - The completion request built using CompletionRequest::builder().
///
/// # Returns
///
/// * `Result<completion::CompletionsResponse, OpenRouterError>` - The response from the completion request, containing the generated text and other details.
///
/// # Example
///
/// ```
/// use openrouter_rs::api::legacy::completion::CompletionRequest;
///
/// let client = OpenRouterClient::builder().api_key("your_api_key").build()?;
/// let request = CompletionRequest::builder()
/// .model("deepseek/deepseek-chat-v3-0324:free")
/// .prompt("Once upon a time")
/// .max_tokens(100)
/// .temperature(0.7)
/// .build()?;
/// let response = client.legacy().completions().create(&request).await?;
/// println!("{:?}", response);
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
#[cfg(feature = "legacy-completions")]
#[deprecated(
since = "0.5.2",
note = "use client.legacy().completions().create(request); send_completion_request() will be removed in 0.6.0"
)]
pub async fn send_completion_request(
&self,
request: &completion::CompletionRequest,
) -> Result<CompletionsResponse, OpenRouterError> {
if let Some(api_key) = &self.api_key {
completion::send_completion_request(
&self.base_url,
api_key,
&self.x_title,
&self.http_referer,
request,
)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Submit an embeddings request.
///
/// # Arguments
///
/// * `request` - The embeddings request built using `EmbeddingRequest::builder()`.
///
/// # Returns
///
/// * `Result<embeddings::EmbeddingResponse, OpenRouterError>` - The embeddings response.
pub async fn create_embedding(
&self,
request: &embeddings::EmbeddingRequest,
) -> Result<embeddings::EmbeddingResponse, OpenRouterError> {
if let Some(api_key) = &self.api_key {
embeddings::create_embedding(
&self.base_url,
api_key,
&self.x_title,
&self.http_referer,
request,
)
.await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// List all available embeddings models.
pub async fn list_embedding_models(&self) -> Result<Vec<models::Model>, OpenRouterError> {
if let Some(api_key) = &self.api_key {
embeddings::list_embedding_models(&self.base_url, api_key).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Creates and hydrates a Coinbase Commerce charge for cryptocurrency payments.
///
/// # Arguments
///
/// * `request` - The request data built using CoinbaseChargeRequest::builder().
///
/// # Returns
///
/// * `Result<credits::CoinbaseChargeData, OpenRouterError>` - The response data containing the charge details.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().api_key("your_api_key").build();
/// let request = credits::CoinbaseChargeRequest::builder()
/// .amount(100.0)
/// .sender("sender_address")
/// .chain_id(1)
/// .build()?;
/// let response = client.create_coinbase_charge(&request).await?;
/// println!("{:?}", response);
/// ```
pub async fn create_coinbase_charge(
&self,
request: &credits::CoinbaseChargeRequest,
) -> Result<credits::CoinbaseChargeData, OpenRouterError> {
if let Some(api_key) = &self.api_key {
credits::create_coinbase_charge(&self.base_url, api_key, request).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Returns the total credits purchased and used for the authenticated user.
///
/// # Returns
///
/// * `Result<credits::CreditsData, OpenRouterError>` - The response data containing the total credits and usage.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().api_key("your_api_key").build();
/// let credits_data = client.get_credits().await?;
/// println!("{:?}", credits_data);
/// ```
pub async fn get_credits(&self) -> Result<credits::CreditsData, OpenRouterError> {
if let Some(api_key) = &self.api_key {
credits::get_credits(&self.base_url, api_key).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Returns metadata about a specific generation request.
///
/// # Arguments
///
/// * `request` - The GenerationRequest built using GenerationRequest::builder().
///
/// # Returns
///
/// * `Result<generation::GenerationData, OpenRouterError>` - The metadata of the generation request or an error.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().api_key("your_api_key").build();
/// let request = generation::GenerationRequest::builder()
/// .id("generation_id")
/// .build()?;
/// let generation_data = client.get_generation(&request).await?;
/// println!("{:?}", generation_data);
/// ```
pub async fn get_generation(
&self,
id: impl Into<String>,
) -> Result<generation::GenerationData, OpenRouterError> {
if let Some(api_key) = &self.api_key {
generation::get_generation(&self.base_url, api_key, id).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Returns a list of models available through the API.
///
/// # Returns
///
/// * `Result<Vec<models::Model>, OpenRouterError>` - A list of models or an error.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().api_key("your_api_key").build();
/// let models = client.list_models().await?;
/// println!("{:?}", models);
/// ```
pub async fn list_models(&self) -> Result<Vec<models::Model>, OpenRouterError> {
if let Some(api_key) = &self.api_key {
models::list_models(&self.base_url, api_key, None, None).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Returns a list of models available through the API by category.
///
/// # Arguments
///
/// * `category` - The category of the models.
///
/// # Returns
///
/// * `Result<Vec<models::Model>, OpenRouterError>` - A list of models or an error.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().api_key("your_api_key").build();
/// let models = client.list_models_by_category(ModelCategory::TextCompletion).await?;
/// println!("{:?}", models);
/// ```
pub async fn list_models_by_category(
&self,
category: ModelCategory,
) -> Result<Vec<models::Model>, OpenRouterError> {
if let Some(api_key) = &self.api_key {
models::list_models(&self.base_url, api_key, Some(category), None).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Returns a list of models available for the specified supported parameters.
///
/// # Arguments
///
/// * `supported_parameters` - The supported parameters for the models.
///
/// # Returns
///
/// * `Result<Vec<models::Model>, OpenRouterError>` - A list of models or an error.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().api_key("your_api_key").build();
/// let models = client.list_models_by_parameters(SupportedParameters::Tools).await?;
/// println!("{:?}", models);
/// ```
pub async fn list_models_by_parameters(
&self,
supported_parameters: SupportedParameters,
) -> Result<Vec<models::Model>, OpenRouterError> {
if let Some(api_key) = &self.api_key {
models::list_models(&self.base_url, api_key, None, Some(supported_parameters)).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Returns details about the endpoints for a specific model.
///
/// # Arguments
///
/// * `author` - The author of the model.
/// * `slug` - The slug identifier for the model.
///
/// # Returns
///
/// * `Result<models::EndpointData, OpenRouterError>` - The endpoint data or an error.
///
/// # Example
///
/// ```
/// let client = OpenRouterClient::builder().api_key("your_api_key").build();
/// let endpoint_data = client.list_model_endpoints("author_name", "model_slug").await?;
/// println!("{:?}", endpoint_data);
/// ```
pub async fn list_model_endpoints(
&self,
author: &str,
slug: &str,
) -> Result<models::EndpointData, OpenRouterError> {
if let Some(api_key) = &self.api_key {
models::list_model_endpoints(&self.base_url, api_key, author, slug).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// List all providers.
///
/// This endpoint is public, but this SDK method still requires `api_key`
/// for consistency with other client operations.
pub async fn list_providers(&self) -> Result<Vec<discovery::Provider>, OpenRouterError> {
if let Some(api_key) = &self.api_key {
discovery::list_providers(&self.base_url, api_key).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// List models filtered by user provider preferences, privacy settings, and guardrails.
///
/// Equivalent to `GET /models/user`.
pub async fn list_models_for_user(&self) -> Result<Vec<discovery::UserModel>, OpenRouterError> {
if let Some(api_key) = &self.api_key {
discovery::list_models_for_user(&self.base_url, api_key).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Get the total number of available models.
///
/// Equivalent to `GET /models/count`.
pub async fn count_models(&self) -> Result<discovery::ModelsCountData, OpenRouterError> {
if let Some(api_key) = &self.api_key {
discovery::count_models(&self.base_url, api_key).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Preview ZDR-compatible endpoints.
///
/// Equivalent to `GET /endpoints/zdr`.
pub async fn list_zdr_endpoints(
&self,
) -> Result<Vec<discovery::PublicEndpoint>, OpenRouterError> {
if let Some(api_key) = &self.api_key {
discovery::list_zdr_endpoints(&self.base_url, api_key).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
/// Get activity grouped by endpoint for the last 30 UTC days.
///
/// Equivalent to `GET /activity`.
///
/// Requires a management API key. In this SDK, configure that via
/// `OpenRouterClientBuilder::management_key(...)`.
///
/// `date` is optional and should be `YYYY-MM-DD`.
pub async fn get_activity(
&self,
date: Option<&str>,
) -> Result<Vec<discovery::ActivityItem>, OpenRouterError> {
if let Some(management_key) = &self.management_key {
discovery::get_activity(&self.base_url, management_key, date).await
} else {
Err(OpenRouterError::KeyNotConfigured)
}
}
}
/// Domain client for chat completions.
#[derive(Debug, Clone, Copy)]
pub struct ChatClient<'a> {
client: &'a OpenRouterClient,
}
impl<'a> ChatClient<'a> {
/// Create a chat completion (`POST /chat/completions`).
pub async fn create(
&self,
request: &chat::ChatCompletionRequest,
) -> Result<CompletionsResponse, OpenRouterError> {
self.client.send_chat_completion(request).await
}
/// Stream chat completion chunks.
pub async fn stream(
&self,
request: &chat::ChatCompletionRequest,
) -> Result<BoxStream<'static, Result<CompletionsResponse, OpenRouterError>>, OpenRouterError>
{
self.client.stream_chat_completion(request).await
}
/// Stream chat completion chunks with tool-call-aware aggregation.
pub async fn stream_tool_aware(
&self,
request: &chat::ChatCompletionRequest,
) -> Result<ToolAwareStream, OpenRouterError> {
self.client.stream_chat_completion_tool_aware(request).await
}
/// Stream chat events using the unified stream abstraction.
pub async fn stream_unified(
&self,
request: &chat::ChatCompletionRequest,
) -> Result<UnifiedStream, OpenRouterError> {
self.client.stream_chat_completion_unified(request).await
}
}
/// Domain client for OpenRouter Responses API.
#[derive(Debug, Clone, Copy)]
pub struct ResponsesClient<'a> {
client: &'a OpenRouterClient,
}
impl<'a> ResponsesClient<'a> {
/// Create a response (`POST /responses`).
pub async fn create(
&self,
request: &responses::ResponsesRequest,
) -> Result<responses::ResponsesResponse, OpenRouterError> {
self.client.create_response(request).await
}
/// Stream response events (`POST /responses`, `stream=true`).
pub async fn stream(
&self,
request: &responses::ResponsesRequest,
) -> Result<
BoxStream<'static, Result<responses::ResponsesStreamEvent, OpenRouterError>>,
OpenRouterError,
> {
self.client.stream_response(request).await
}
/// Stream response events using the unified stream abstraction.
pub async fn stream_unified(
&self,
request: &responses::ResponsesRequest,
) -> Result<UnifiedStream, OpenRouterError> {
self.client.stream_response_unified(request).await
}
}
/// Domain client for Anthropic-compatible Messages API.
#[derive(Debug, Clone, Copy)]
pub struct MessagesClient<'a> {
client: &'a OpenRouterClient,
}
impl<'a> MessagesClient<'a> {
/// Create a non-streaming message (`POST /messages`).
pub async fn create(
&self,
request: &messages::AnthropicMessagesRequest,
) -> Result<messages::AnthropicMessagesResponse, OpenRouterError> {
self.client.create_message(request).await
}
/// Stream SSE events from `/messages`.
pub async fn stream(
&self,
request: &messages::AnthropicMessagesRequest,
) -> Result<
BoxStream<'static, Result<messages::AnthropicMessagesSseEvent, OpenRouterError>>,
OpenRouterError,
> {
self.client.stream_messages(request).await
}
/// Stream messages events using the unified stream abstraction.
pub async fn stream_unified(
&self,
request: &messages::AnthropicMessagesRequest,
) -> Result<UnifiedStream, OpenRouterError> {
self.client.stream_messages_unified(request).await
}
}
/// Domain client for model/discovery/embedding endpoints.
#[derive(Debug, Clone, Copy)]
pub struct ModelsClient<'a> {
client: &'a OpenRouterClient,
}
impl<'a> ModelsClient<'a> {
/// List all models (`GET /models`).
pub async fn list(&self) -> Result<Vec<models::Model>, OpenRouterError> {
self.client.list_models().await
}
/// List models by category (`GET /models?category=...`).
pub async fn list_by_category(
&self,
category: ModelCategory,
) -> Result<Vec<models::Model>, OpenRouterError> {
self.client.list_models_by_category(category).await
}
/// List models by supported parameter (`GET /models?supported_parameters=...`).
pub async fn list_by_parameters(
&self,
supported_parameters: SupportedParameters,
) -> Result<Vec<models::Model>, OpenRouterError> {
self.client
.list_models_by_parameters(supported_parameters)
.await
}
/// List model endpoints (`GET /models/{author}/{slug}/endpoints`).
pub async fn list_endpoints(
&self,
author: &str,
slug: &str,
) -> Result<models::EndpointData, OpenRouterError> {
self.client.list_model_endpoints(author, slug).await
}
/// List providers (`GET /providers`).
pub async fn list_providers(&self) -> Result<Vec<discovery::Provider>, OpenRouterError> {
self.client.list_providers().await
}
/// List user-filtered models (`GET /models/user`).
pub async fn list_user_models(&self) -> Result<Vec<discovery::UserModel>, OpenRouterError> {
self.client.list_models_for_user().await
}
#[deprecated(
since = "0.5.2",
note = "renamed to list_user_models(); list_for_user() will be removed in 0.6.0"
)]
pub async fn list_for_user(&self) -> Result<Vec<discovery::UserModel>, OpenRouterError> {
self.list_user_models().await
}
/// Get available model count (`GET /models/count`).
pub async fn get_model_count(&self) -> Result<discovery::ModelsCountData, OpenRouterError> {
self.client.count_models().await
}
#[deprecated(
since = "0.5.2",
note = "renamed to get_model_count(); count() will be removed in 0.6.0"
)]
pub async fn count(&self) -> Result<discovery::ModelsCountData, OpenRouterError> {
self.get_model_count().await
}
/// List ZDR-compatible endpoints (`GET /endpoints/zdr`).
pub async fn list_zdr_endpoints(
&self,
) -> Result<Vec<discovery::PublicEndpoint>, OpenRouterError> {
self.client.list_zdr_endpoints().await
}
/// Create an embedding (`POST /embeddings`).
pub async fn create_embedding(
&self,
request: &embeddings::EmbeddingRequest,
) -> Result<embeddings::EmbeddingResponse, OpenRouterError> {
self.client.create_embedding(request).await
}
/// List embedding models (`GET /embeddings/models`).
pub async fn list_embedding_models(&self) -> Result<Vec<models::Model>, OpenRouterError> {
self.client.list_embedding_models().await
}
}
/// Domain client for management endpoints.
#[derive(Debug, Clone, Copy)]
pub struct ManagementClient<'a> {
client: &'a OpenRouterClient,
}
impl<'a> ManagementClient<'a> {
/// Create a managed API key (`POST /keys`).
pub async fn create_api_key(
&self,
name: &str,
limit: Option<f64>,
) -> Result<api_keys::ApiKey, OpenRouterError> {
self.client.create_api_key(name, limit).await
}
/// Get current key session info (`GET /key`).
pub async fn get_current_api_key_info(
&self,
) -> Result<api_keys::ApiKeyDetails, OpenRouterError> {
self.client.get_current_api_key_info().await
}
/// Delete an API key (`DELETE /keys/{hash}`).
pub async fn delete_api_key(&self, hash: &str) -> Result<bool, OpenRouterError> {
self.client.delete_api_key(hash).await
}
/// Update an API key (`PATCH /keys/{hash}`).
pub async fn update_api_key(
&self,
hash: &str,
name: Option<String>,
disabled: Option<bool>,
limit: Option<f64>,
) -> Result<api_keys::ApiKey, OpenRouterError> {
self.client
.update_api_key(hash, name, disabled, limit)
.await
}
/// List API keys (`GET /keys`).
pub async fn list_api_keys(
&self,
pagination: Option<PaginationOptions>,
include_disabled: Option<bool>,
) -> Result<Vec<api_keys::ApiKey>, OpenRouterError> {
self.client
.list_api_keys_paginated(pagination, include_disabled)
.await
}
/// Get an API key (`GET /keys/{hash}`).
pub async fn get_api_key(&self, hash: &str) -> Result<api_keys::ApiKey, OpenRouterError> {
self.client.get_api_key(hash).await
}
/// Create OAuth auth code (`POST /auth/keys/code`).
pub async fn create_auth_code(
&self,
request: &auth::CreateAuthCodeRequest,
) -> Result<auth::AuthCodeData, OpenRouterError> {
self.client.create_auth_code(request).await
}
/// Create an API key from auth code (`POST /auth/keys`).
pub async fn create_api_key_from_auth_code(
&self,
code: &str,
code_verifier: Option<&str>,
code_challenge_method: Option<auth::CodeChallengeMethod>,
) -> Result<auth::AuthResponse, OpenRouterError> {
self.client
.exchange_code_for_api_key(code, code_verifier, code_challenge_method)
.await
}
#[deprecated(
since = "0.5.2",
note = "renamed to create_api_key_from_auth_code(...); exchange_code_for_api_key(...) will be removed in 0.6.0"
)]
pub async fn exchange_code_for_api_key(
&self,
code: &str,
code_verifier: Option<&str>,
code_challenge_method: Option<auth::CodeChallengeMethod>,
) -> Result<auth::AuthResponse, OpenRouterError> {
self.create_api_key_from_auth_code(code, code_verifier, code_challenge_method)
.await
}
/// Create a Coinbase charge (`POST /credits/coinbase`).
pub async fn create_coinbase_charge(
&self,
request: &credits::CoinbaseChargeRequest,
) -> Result<credits::CoinbaseChargeData, OpenRouterError> {
self.client.create_coinbase_charge(request).await
}
/// Get credits (`GET /credits`).
pub async fn get_credits(&self) -> Result<credits::CreditsData, OpenRouterError> {
self.client.get_credits().await
}
/// Get generation metadata (`GET /generation?id=...`).
pub async fn get_generation(
&self,
id: impl Into<String>,
) -> Result<generation::GenerationData, OpenRouterError> {
self.client.get_generation(id).await
}
/// Get endpoint usage activity (`GET /activity`).
pub async fn get_activity(
&self,
date: Option<&str>,
) -> Result<Vec<discovery::ActivityItem>, OpenRouterError> {
self.client.get_activity(date).await
}
/// List guardrails (`GET /guardrails`).
pub async fn list_guardrails(
&self,
pagination: Option<PaginationOptions>,
) -> Result<guardrails::GuardrailListResponse, OpenRouterError> {
self.client.list_guardrails(pagination).await
}
/// Create a guardrail (`POST /guardrails`).
pub async fn create_guardrail(
&self,
request: &guardrails::CreateGuardrailRequest,
) -> Result<guardrails::Guardrail, OpenRouterError> {
self.client.create_guardrail(request).await
}
/// Get a guardrail (`GET /guardrails/{id}`).
pub async fn get_guardrail(&self, id: &str) -> Result<guardrails::Guardrail, OpenRouterError> {
self.client.get_guardrail(id).await
}
/// Update a guardrail (`PATCH /guardrails/{id}`).
pub async fn update_guardrail(
&self,
id: &str,
request: &guardrails::UpdateGuardrailRequest,
) -> Result<guardrails::Guardrail, OpenRouterError> {
self.client.update_guardrail(id, request).await
}
/// Delete a guardrail (`DELETE /guardrails/{id}`).
pub async fn delete_guardrail(&self, id: &str) -> Result<bool, OpenRouterError> {
self.client.delete_guardrail(id).await
}
/// List key assignments for a guardrail.
pub async fn list_guardrail_key_assignments(
&self,
id: &str,
pagination: Option<PaginationOptions>,
) -> Result<guardrails::GuardrailKeyAssignmentsResponse, OpenRouterError> {
self.client
.list_guardrail_key_assignments(id, pagination)
.await
}
/// Create key assignments for a guardrail.
pub async fn create_guardrail_key_assignments(
&self,
id: &str,
request: &guardrails::BulkKeyAssignmentRequest,
) -> Result<guardrails::AssignedCountResponse, OpenRouterError> {
self.client.bulk_assign_keys_to_guardrail(id, request).await
}
/// Delete key assignments from a guardrail.
pub async fn delete_guardrail_key_assignments(
&self,
id: &str,
request: &guardrails::BulkKeyAssignmentRequest,
) -> Result<guardrails::UnassignedCountResponse, OpenRouterError> {
self.client
.bulk_unassign_keys_from_guardrail(id, request)
.await
}
/// List member assignments for a guardrail.
pub async fn list_guardrail_member_assignments(
&self,
id: &str,
pagination: Option<PaginationOptions>,
) -> Result<guardrails::GuardrailMemberAssignmentsResponse, OpenRouterError> {
self.client
.list_guardrail_member_assignments(id, pagination)
.await
}
/// Create member assignments for a guardrail.
pub async fn create_guardrail_member_assignments(
&self,
id: &str,
request: &guardrails::BulkMemberAssignmentRequest,
) -> Result<guardrails::AssignedCountResponse, OpenRouterError> {
self.client
.bulk_assign_members_to_guardrail(id, request)
.await
}
/// Delete member assignments from a guardrail.
pub async fn delete_guardrail_member_assignments(
&self,
id: &str,
request: &guardrails::BulkMemberAssignmentRequest,
) -> Result<guardrails::UnassignedCountResponse, OpenRouterError> {
self.client
.bulk_unassign_members_from_guardrail(id, request)
.await
}
/// List global key assignments.
pub async fn list_key_assignments(
&self,
pagination: Option<PaginationOptions>,
) -> Result<guardrails::GuardrailKeyAssignmentsResponse, OpenRouterError> {
self.client.list_key_assignments(pagination).await
}
/// List global member assignments.
pub async fn list_member_assignments(
&self,
pagination: Option<PaginationOptions>,
) -> Result<guardrails::GuardrailMemberAssignmentsResponse, OpenRouterError> {
self.client.list_member_assignments(pagination).await
}
}
/// Domain client for legacy APIs (`legacy-completions` feature only).
#[cfg(feature = "legacy-completions")]
#[derive(Debug, Clone, Copy)]
pub struct LegacyClient<'a> {
client: &'a OpenRouterClient,
}
#[cfg(feature = "legacy-completions")]
impl<'a> LegacyClient<'a> {
/// Domain client for legacy text completions (`POST /completions`).
pub fn completions(&self) -> LegacyCompletionsClient<'a> {
LegacyCompletionsClient {
client: self.client,
}
}
}
/// Domain client for legacy text completions (`legacy-completions` feature only).
#[cfg(feature = "legacy-completions")]
#[derive(Debug, Clone, Copy)]
pub struct LegacyCompletionsClient<'a> {
client: &'a OpenRouterClient,
}
#[cfg(feature = "legacy-completions")]
impl<'a> LegacyCompletionsClient<'a> {
/// Create a legacy text completion (`POST /completions`).
#[allow(deprecated)]
pub async fn create(
&self,
request: &completion::CompletionRequest,
) -> Result<CompletionsResponse, OpenRouterError> {
self.client.send_completion_request(request).await
}
}