realtime-avatar 0.27.4 → 0.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +93 -4
- package/dist/{chunk-NNX2ZSA3.js → chunk-K3VC6BF7.js} +5 -1
- package/dist/{chunk-VVQIYWKT.js → chunk-V7A4NRKC.js} +238 -37
- package/dist/express.d.ts +2 -2
- package/dist/express.js +2 -2
- package/dist/hono.d.ts +2 -2
- package/dist/hono.js +2 -2
- package/dist/index.d.ts +40 -6
- package/dist/index.js +1 -1
- package/dist/nextjs.d.ts +2 -2
- package/dist/nextjs.js +2 -2
- package/dist/{proxy-client-e4ingu8g.d.ts → proxy-client-WjGIwL-t.d.ts} +45 -2
- package/dist/react-native.d.ts +2 -2
- package/dist/react-native.js +53 -4
- package/dist/react.d.ts +12 -3
- package/dist/react.js +57 -6
- package/dist/server.d.ts +2 -2
- package/dist/server.js +1 -1
- package/dist/tanstack-start.d.ts +2 -2
- package/dist/tanstack-start.js +2 -2
- package/dist/{types-dqrXXrhz.d.ts → types-Bli1UeP0.d.ts} +1 -1
- package/dist/{types-BKv6pxzd.d.ts → types-yiemDkm0.d.ts} +2009 -256
- package/package.json +1 -1
|
@@ -88,7 +88,7 @@ interface components {
|
|
|
88
88
|
* @default speech-1.6
|
|
89
89
|
* @enum {string}
|
|
90
90
|
*/
|
|
91
|
-
model: "speech-1.6" | "s1" | "s2-pro" | "speech-1.5" | "s1-mini";
|
|
91
|
+
model: "speech-1.6" | "s1" | "s2-pro" | "drama-3" | "speech-1.5" | "s1-mini";
|
|
92
92
|
voice_id: string;
|
|
93
93
|
speed?: number | null;
|
|
94
94
|
emotion?: string | null;
|
|
@@ -184,6 +184,27 @@ interface components {
|
|
|
184
184
|
client_metadata?: {
|
|
185
185
|
[key: string]: string;
|
|
186
186
|
};
|
|
187
|
+
/** @description Speak this call with your own voice: the worker POSTs each sentence to url and plays the audio you return. Replaces voice and voice_id. */
|
|
188
|
+
voice_webhook?: {
|
|
189
|
+
/**
|
|
190
|
+
* Format: uri
|
|
191
|
+
* @description https:// endpoint on your server that returns speech audio for one sentence. The worker also refuses a host that resolves to a non-public address and never follows redirects.
|
|
192
|
+
*/
|
|
193
|
+
url: string;
|
|
194
|
+
/** @description HMAC-SHA256 key for x-rta-signature, the same scheme as transcript_webhook. Never placed in room or participant metadata. */
|
|
195
|
+
secret: string;
|
|
196
|
+
/** @description Your own voice identifier, echoed in every request as voice_id. */
|
|
197
|
+
voice_id?: string;
|
|
198
|
+
/** @description BCP-47 language hint, echoed in every request as language. */
|
|
199
|
+
language?: string;
|
|
200
|
+
/**
|
|
201
|
+
* @description Sample rate of raw audio/pcm replies, in Hz. Default 24000.
|
|
202
|
+
* @enum {number}
|
|
203
|
+
*/
|
|
204
|
+
sample_rate?: 8000 | 16000 | 22050 | 24000 | 44100 | 48000;
|
|
205
|
+
/** @description In milliseconds, default 5000. Bounds the first audio byte of each attempt and every later gap between chunks; past it the reply fails with voice_webhook_timeout. */
|
|
206
|
+
timeout_ms?: number;
|
|
207
|
+
};
|
|
187
208
|
/** @description DEPRECATED, no-op. Accepted and ignored. The faster hesitation ceiling this requested is now the default for every session, so sending it changes nothing. Safe to stop sending; the field is retained only so existing callers do not break. */
|
|
188
209
|
fast_endpointing?: boolean;
|
|
189
210
|
require_ready_clip_library?: boolean;
|
|
@@ -655,6 +676,48 @@ interface components {
|
|
|
655
676
|
} & {
|
|
656
677
|
[key: string]: unknown;
|
|
657
678
|
};
|
|
679
|
+
/** @description One sentence to synthesize, signed with voice_webhook.secret. Reply 200 with streamed audio. */
|
|
680
|
+
VoiceWebhookRequest: {
|
|
681
|
+
/** @constant */
|
|
682
|
+
type: "voice.synthesize";
|
|
683
|
+
/** @constant */
|
|
684
|
+
version: 1;
|
|
685
|
+
/** @description Unique per POST; also sent as the x-rta-request-id header. */
|
|
686
|
+
request_id: string;
|
|
687
|
+
/** @description The same session id the transcript webhook payload carries. */
|
|
688
|
+
session_id: string;
|
|
689
|
+
/** @description The plain words to speak: no markup and no stage directions. */
|
|
690
|
+
text: string;
|
|
691
|
+
/** @description voice_webhook.voice_id from the mint, or null. */
|
|
692
|
+
voice_id: string | null;
|
|
693
|
+
/** @description voice_webhook.language from the mint, or null. */
|
|
694
|
+
language: string | null;
|
|
695
|
+
/** @description The raw audio/pcm format expected when the reply does not name another. */
|
|
696
|
+
output: {
|
|
697
|
+
/** @constant */
|
|
698
|
+
encoding: "pcm_s16le";
|
|
699
|
+
/** @enum {number} */
|
|
700
|
+
sample_rate: 8000 | 16000 | 22050 | 24000 | 44100 | 48000;
|
|
701
|
+
/** @constant */
|
|
702
|
+
channels: 1;
|
|
703
|
+
};
|
|
704
|
+
/** @description Mint-time client_metadata echoed verbatim; an empty object when none was provided. */
|
|
705
|
+
client_metadata: {
|
|
706
|
+
[key: string]: string;
|
|
707
|
+
};
|
|
708
|
+
};
|
|
709
|
+
/** @enum {string} */
|
|
710
|
+
VoiceWebhookErrorCode: "voice_webhook_url_not_allowed" | "voice_webhook_unauthorized" | "voice_webhook_unreachable" | "voice_webhook_timeout" | "voice_webhook_http_error" | "voice_webhook_unsupported_audio" | "voice_webhook_empty_audio";
|
|
711
|
+
VoiceErrorFrame: {
|
|
712
|
+
/** @constant */
|
|
713
|
+
kind: "voice_error";
|
|
714
|
+
/** @enum {string} */
|
|
715
|
+
code: "voice_webhook_url_not_allowed" | "voice_webhook_unauthorized" | "voice_webhook_unreachable" | "voice_webhook_timeout" | "voice_webhook_http_error" | "voice_webhook_unsupported_audio" | "voice_webhook_empty_audio";
|
|
716
|
+
message: string;
|
|
717
|
+
status?: number;
|
|
718
|
+
fatal: boolean;
|
|
719
|
+
request_id?: string;
|
|
720
|
+
};
|
|
658
721
|
Avatar: {
|
|
659
722
|
id: string;
|
|
660
723
|
tenantId: string;
|
|
@@ -774,7 +837,7 @@ interface components {
|
|
|
774
837
|
* "avatars:read"
|
|
775
838
|
* ]
|
|
776
839
|
*/
|
|
777
|
-
scopes: ("*" | "api_keys:write" | "credits:read" | "avatars:read" | "avatars:write" | "realtime:write" | "usage:read" | "recordings:read" | "usage:write")[];
|
|
840
|
+
scopes: ("*" | "api_keys:write" | "credits:read" | "avatars:read" | "avatars:write" | "realtime:write" | "usage:read" | "recordings:read" | "usage:write" | "speech:write")[];
|
|
778
841
|
spendLimitCreditMicros?: number | null;
|
|
779
842
|
expiresAt?: string | null;
|
|
780
843
|
};
|
|
@@ -786,7 +849,7 @@ interface components {
|
|
|
786
849
|
redactedKey: string;
|
|
787
850
|
/** @default false */
|
|
788
851
|
canReveal: boolean;
|
|
789
|
-
scopes: ("*" | "api_keys:write" | "credits:read" | "avatars:read" | "avatars:write" | "realtime:write" | "usage:read" | "recordings:read" | "usage:write")[];
|
|
852
|
+
scopes: ("*" | "api_keys:write" | "credits:read" | "avatars:read" | "avatars:write" | "realtime:write" | "usage:read" | "recordings:read" | "usage:write" | "speech:write")[];
|
|
790
853
|
/** @enum {string} */
|
|
791
854
|
status: "active" | "revoked" | "expired";
|
|
792
855
|
spendLimitCreditMicros: number | null;
|
|
@@ -898,6 +961,20 @@ interface components {
|
|
|
898
961
|
total_ms?: number;
|
|
899
962
|
};
|
|
900
963
|
};
|
|
964
|
+
CreateSpeechRequest: {
|
|
965
|
+
/** @description What to say, at most 2,000 characters after trimming. Billed per UTF-8 byte: plain English is one byte per character, accented letters and other scripts use 2 to 4. Text in [square brackets] may be performed as a delivery cue rather than spoken. */
|
|
966
|
+
text: string;
|
|
967
|
+
/**
|
|
968
|
+
* @description mp3 (44.1 kHz, 128 kbps, mono) or wav.
|
|
969
|
+
* @default mp3
|
|
970
|
+
* @enum {string}
|
|
971
|
+
*/
|
|
972
|
+
format: "mp3" | "wav";
|
|
973
|
+
/** @description Speaking rate, 0.5 to 2. Omit for the voice's natural pace. */
|
|
974
|
+
speed?: number;
|
|
975
|
+
/** @description BCP-47 tag such as en-AU. Shapes how numbers, dates and units are read; it does not change the voice. */
|
|
976
|
+
language?: string;
|
|
977
|
+
};
|
|
901
978
|
CreditBalance: {
|
|
902
979
|
tenantId: string;
|
|
903
980
|
balanceCreditMicros: number;
|
|
@@ -910,6 +987,31 @@ interface components {
|
|
|
910
987
|
ListUsageSessionsResponse: {
|
|
911
988
|
data: {
|
|
912
989
|
sessionId: string;
|
|
990
|
+
/** @description Only returned for X-RTA-Speech-Diagnostics: 1. Closed dialogue record, whole-session cohort, not sliced to query dates or pooled across turns. Missing legs remain absent. Opt-in pages cap at 50; 65536 bytes per summary, 5000 ms total page deadline, concurrency 4. Unavailable evidence is explicit, never zero. */
|
|
991
|
+
readonly speechDiagnostics?: {
|
|
992
|
+
latency_ms: {
|
|
993
|
+
[key: string]: {
|
|
994
|
+
count: number;
|
|
995
|
+
max: number;
|
|
996
|
+
p50: number;
|
|
997
|
+
p90: number;
|
|
998
|
+
};
|
|
999
|
+
};
|
|
1000
|
+
/** @constant */
|
|
1001
|
+
status: "available";
|
|
1002
|
+
/** @constant */
|
|
1003
|
+
sourceRole: "dialogue";
|
|
1004
|
+
coverage: {
|
|
1005
|
+
first_at: string | null;
|
|
1006
|
+
last_at: string | null;
|
|
1007
|
+
lines: number;
|
|
1008
|
+
};
|
|
1009
|
+
} | {
|
|
1010
|
+
/** @constant */
|
|
1011
|
+
status: "unavailable";
|
|
1012
|
+
/** @enum {string} */
|
|
1013
|
+
reason: "not_closed" | "unconfigured" | "missing" | "invalid" | "oversized" | "unscorable" | "no_measured_latency" | "timeout" | "aborted" | "storage_unavailable";
|
|
1014
|
+
};
|
|
913
1015
|
/** @description Returned only for X-RTA-Release-Evidence: 1. Omitted by default for strict client compatibility. Evidence is stored against this session; missing evidence remains null. */
|
|
914
1016
|
readonly releaseIdentity?: {
|
|
915
1017
|
deploymentId: string | null;
|
|
@@ -1375,9 +1477,9 @@ interface components {
|
|
|
1375
1477
|
* @description Present on `403 insufficient_scope` — the one scope this operation needed and the key did not carry. Repeated in the `WWW-Authenticate` challenge as `scope=`.
|
|
1376
1478
|
* @enum {string}
|
|
1377
1479
|
*/
|
|
1378
|
-
requiredScope?: "*" | "api_keys:write" | "credits:read" | "avatars:read" | "avatars:write" | "realtime:write" | "usage:read" | "recordings:read" | "usage:write";
|
|
1480
|
+
requiredScope?: "*" | "api_keys:write" | "credits:read" | "avatars:read" | "avatars:write" | "realtime:write" | "usage:read" | "recordings:read" | "usage:write" | "speech:write";
|
|
1379
1481
|
/** @description Present alongside `requiredScope` — the scopes the presented key does carry. */
|
|
1380
|
-
grantedScopes?: ("*" | "api_keys:write" | "credits:read" | "avatars:read" | "avatars:write" | "realtime:write" | "usage:read" | "recordings:read" | "usage:write")[];
|
|
1482
|
+
grantedScopes?: ("*" | "api_keys:write" | "credits:read" | "avatars:read" | "avatars:write" | "realtime:write" | "usage:read" | "recordings:read" | "usage:write" | "speech:write")[];
|
|
1381
1483
|
/** @description Present on 402 — where to send the user to top up. */
|
|
1382
1484
|
billingUrl?: string;
|
|
1383
1485
|
/** @description On concurrency_limit_reached: the workspace's concurrent session limit. */
|
|
@@ -1400,229 +1502,1876 @@ interface components {
|
|
|
1400
1502
|
headers: never;
|
|
1401
1503
|
pathItems: never;
|
|
1402
1504
|
}
|
|
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
|
-
|
|
1505
|
+
interface operations {
|
|
1506
|
+
getLiveKitCapacity: {
|
|
1507
|
+
parameters: {
|
|
1508
|
+
query?: never;
|
|
1509
|
+
header?: never;
|
|
1510
|
+
path?: never;
|
|
1511
|
+
cookie?: never;
|
|
1512
|
+
};
|
|
1513
|
+
requestBody?: never;
|
|
1514
|
+
responses: {
|
|
1515
|
+
/** @description Capacity snapshot */
|
|
1516
|
+
200: {
|
|
1517
|
+
headers: {
|
|
1518
|
+
[name: string]: unknown;
|
|
1519
|
+
};
|
|
1520
|
+
content: {
|
|
1521
|
+
"application/json": components["schemas"]["LiveKitCapacitySnapshot"];
|
|
1522
|
+
};
|
|
1523
|
+
};
|
|
1524
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
1525
|
+
401: {
|
|
1526
|
+
headers: {
|
|
1527
|
+
[name: string]: unknown;
|
|
1528
|
+
};
|
|
1529
|
+
content: {
|
|
1530
|
+
"application/json": components["schemas"]["Error"];
|
|
1531
|
+
};
|
|
1532
|
+
};
|
|
1533
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
1534
|
+
403: {
|
|
1535
|
+
headers: {
|
|
1536
|
+
[name: string]: unknown;
|
|
1537
|
+
};
|
|
1538
|
+
content: {
|
|
1539
|
+
"application/json": components["schemas"]["Error"];
|
|
1540
|
+
};
|
|
1541
|
+
};
|
|
1542
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
1543
|
+
default: {
|
|
1544
|
+
headers: {
|
|
1545
|
+
[name: string]: unknown;
|
|
1546
|
+
};
|
|
1547
|
+
content: {
|
|
1548
|
+
"application/json": components["schemas"]["Error"];
|
|
1549
|
+
};
|
|
1550
|
+
};
|
|
1551
|
+
};
|
|
1552
|
+
};
|
|
1553
|
+
createLiveKitSession: {
|
|
1554
|
+
parameters: {
|
|
1555
|
+
query?: never;
|
|
1556
|
+
header?: {
|
|
1557
|
+
/** @description Send 1 to include optional session-bound releaseIdentity in this response. Without this opt-in the field is omitted for strict client compatibility. Capture and storage are independent of this header; missing evidence remains null. Older servers may ignore this header. */
|
|
1558
|
+
"X-RTA-Release-Evidence"?: "1";
|
|
1559
|
+
/** @description Send exactly identity-v1 to include optional usage_account_id on a successful mint after billing attachment. Sourced only from the platform billing hold tenant ID. Other or missing values omit the field; failures and queued responses never include it. Success responses are Cache-Control: no-store. Older servers may omit the field. Independent of X-RTA-Release-Evidence and connection_history policy. */
|
|
1560
|
+
"X-RTA-Observability"?: "identity-v1";
|
|
1561
|
+
};
|
|
1562
|
+
path?: never;
|
|
1563
|
+
cookie?: never;
|
|
1564
|
+
};
|
|
1565
|
+
requestBody: {
|
|
1566
|
+
content: {
|
|
1567
|
+
"application/json": components["schemas"]["LiveKitSessionRequest"];
|
|
1568
|
+
};
|
|
1569
|
+
};
|
|
1570
|
+
responses: {
|
|
1571
|
+
/** @description LiveKit session grant */
|
|
1572
|
+
200: {
|
|
1573
|
+
headers: {
|
|
1574
|
+
[name: string]: unknown;
|
|
1575
|
+
};
|
|
1576
|
+
content: {
|
|
1577
|
+
"application/json": components["schemas"]["LiveKitSessionGrant"];
|
|
1578
|
+
};
|
|
1579
|
+
};
|
|
1580
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
1581
|
+
401: {
|
|
1582
|
+
headers: {
|
|
1583
|
+
[name: string]: unknown;
|
|
1584
|
+
};
|
|
1585
|
+
content: {
|
|
1586
|
+
"application/json": components["schemas"]["Error"];
|
|
1587
|
+
};
|
|
1588
|
+
};
|
|
1589
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
1590
|
+
403: {
|
|
1591
|
+
headers: {
|
|
1592
|
+
[name: string]: unknown;
|
|
1593
|
+
};
|
|
1594
|
+
content: {
|
|
1595
|
+
"application/json": components["schemas"]["Error"];
|
|
1596
|
+
};
|
|
1597
|
+
};
|
|
1598
|
+
/** @description Either the workspace session limit was reached (code "concurrency_limit_reached", top-level maxConcurrentSessions, liveSessions, activeSessions, connectingSessions, pendingSessions), or session capacity is unavailable (the queue contract). Queue responses classify full seats, no workers, or draining workers in x-rta-capacity-refusal; absent or unknown headers mean capacity_full. Starting and connecting sessions count toward the workspace limit. End a session or wait for pending starts to clear before retrying; avoid parallel duplicate starts. Plan refusals are not queue positions. Retain requestId for support. */
|
|
1599
|
+
429: {
|
|
1600
|
+
headers: {
|
|
1601
|
+
/** @description Queue refusal class. Optional for older deployments; missing or unknown means capacity_full. The strict queue body is unchanged. */
|
|
1602
|
+
"x-rta-capacity-refusal"?: "capacity_full" | "capacity_no_workers" | "capacity_draining";
|
|
1603
|
+
[name: string]: unknown;
|
|
1604
|
+
};
|
|
1605
|
+
content: {
|
|
1606
|
+
"application/json": components["schemas"]["CapacityBusyResponse"] | components["schemas"]["Error"];
|
|
1607
|
+
};
|
|
1608
|
+
};
|
|
1609
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
1610
|
+
default: {
|
|
1611
|
+
headers: {
|
|
1612
|
+
[name: string]: unknown;
|
|
1613
|
+
};
|
|
1614
|
+
content: {
|
|
1615
|
+
"application/json": components["schemas"]["Error"];
|
|
1616
|
+
};
|
|
1617
|
+
};
|
|
1618
|
+
};
|
|
1619
|
+
};
|
|
1620
|
+
releaseLiveKitClientSession: {
|
|
1621
|
+
parameters: {
|
|
1622
|
+
query?: never;
|
|
1623
|
+
header?: never;
|
|
1624
|
+
path?: never;
|
|
1625
|
+
cookie?: never;
|
|
1626
|
+
};
|
|
1627
|
+
requestBody: {
|
|
1628
|
+
content: {
|
|
1629
|
+
"application/json": components["schemas"]["LiveKitSessionReleaseRequest"];
|
|
1630
|
+
};
|
|
1631
|
+
};
|
|
1632
|
+
responses: {
|
|
1633
|
+
/** @description Released */
|
|
1634
|
+
200: {
|
|
1635
|
+
headers: {
|
|
1636
|
+
[name: string]: unknown;
|
|
1637
|
+
};
|
|
1638
|
+
content: {
|
|
1639
|
+
"application/json": components["schemas"]["OkResponse"];
|
|
1640
|
+
};
|
|
1641
|
+
};
|
|
1642
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
1643
|
+
401: {
|
|
1644
|
+
headers: {
|
|
1645
|
+
[name: string]: unknown;
|
|
1646
|
+
};
|
|
1647
|
+
content: {
|
|
1648
|
+
"application/json": components["schemas"]["Error"];
|
|
1649
|
+
};
|
|
1650
|
+
};
|
|
1651
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
1652
|
+
403: {
|
|
1653
|
+
headers: {
|
|
1654
|
+
[name: string]: unknown;
|
|
1655
|
+
};
|
|
1656
|
+
content: {
|
|
1657
|
+
"application/json": components["schemas"]["Error"];
|
|
1658
|
+
};
|
|
1659
|
+
};
|
|
1660
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
1661
|
+
default: {
|
|
1662
|
+
headers: {
|
|
1663
|
+
[name: string]: unknown;
|
|
1664
|
+
};
|
|
1665
|
+
content: {
|
|
1666
|
+
"application/json": components["schemas"]["Error"];
|
|
1667
|
+
};
|
|
1668
|
+
};
|
|
1669
|
+
};
|
|
1670
|
+
};
|
|
1671
|
+
createScene: {
|
|
1672
|
+
parameters: {
|
|
1673
|
+
query?: never;
|
|
1674
|
+
header?: never;
|
|
1675
|
+
path?: never;
|
|
1676
|
+
cookie?: never;
|
|
1677
|
+
};
|
|
1678
|
+
requestBody: {
|
|
1679
|
+
content: {
|
|
1680
|
+
"application/json": components["schemas"]["CreateSceneRequest"];
|
|
1681
|
+
};
|
|
1682
|
+
};
|
|
1683
|
+
responses: {
|
|
1684
|
+
/** @description Ready or failed */
|
|
1685
|
+
200: {
|
|
1686
|
+
headers: {
|
|
1687
|
+
[name: string]: unknown;
|
|
1688
|
+
};
|
|
1689
|
+
content: {
|
|
1690
|
+
"application/json": components["schemas"]["SceneState"];
|
|
1691
|
+
};
|
|
1692
|
+
};
|
|
1693
|
+
/** @description Building */
|
|
1694
|
+
202: {
|
|
1695
|
+
headers: {
|
|
1696
|
+
[name: string]: unknown;
|
|
1697
|
+
};
|
|
1698
|
+
content: {
|
|
1699
|
+
"application/json": components["schemas"]["SceneState"];
|
|
1700
|
+
};
|
|
1701
|
+
};
|
|
1702
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
1703
|
+
401: {
|
|
1704
|
+
headers: {
|
|
1705
|
+
[name: string]: unknown;
|
|
1706
|
+
};
|
|
1707
|
+
content: {
|
|
1708
|
+
"application/json": components["schemas"]["Error"];
|
|
1709
|
+
};
|
|
1710
|
+
};
|
|
1711
|
+
/** @description The key lacks the scope for this operation, the tenant is not active, or scene sessions are not enabled for the workspace — code "scene_sessions_not_enabled", a per-workspace preview gate. Contact support to opt in. */
|
|
1712
|
+
403: {
|
|
1713
|
+
headers: {
|
|
1714
|
+
[name: string]: unknown;
|
|
1715
|
+
};
|
|
1716
|
+
content: {
|
|
1717
|
+
"application/json": components["schemas"]["Error"];
|
|
1718
|
+
};
|
|
1719
|
+
};
|
|
1720
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
1721
|
+
default: {
|
|
1722
|
+
headers: {
|
|
1723
|
+
[name: string]: unknown;
|
|
1724
|
+
};
|
|
1725
|
+
content: {
|
|
1726
|
+
"application/json": components["schemas"]["Error"];
|
|
1727
|
+
};
|
|
1728
|
+
};
|
|
1729
|
+
};
|
|
1730
|
+
};
|
|
1731
|
+
getScene: {
|
|
1732
|
+
parameters: {
|
|
1733
|
+
query?: never;
|
|
1734
|
+
header?: never;
|
|
1735
|
+
path: {
|
|
1736
|
+
sceneId: string;
|
|
1737
|
+
};
|
|
1738
|
+
cookie?: never;
|
|
1739
|
+
};
|
|
1740
|
+
requestBody?: never;
|
|
1741
|
+
responses: {
|
|
1742
|
+
/** @description Scene state */
|
|
1743
|
+
200: {
|
|
1744
|
+
headers: {
|
|
1745
|
+
[name: string]: unknown;
|
|
1746
|
+
};
|
|
1747
|
+
content: {
|
|
1748
|
+
"application/json": components["schemas"]["SceneState"];
|
|
1749
|
+
};
|
|
1750
|
+
};
|
|
1751
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
1752
|
+
401: {
|
|
1753
|
+
headers: {
|
|
1754
|
+
[name: string]: unknown;
|
|
1755
|
+
};
|
|
1756
|
+
content: {
|
|
1757
|
+
"application/json": components["schemas"]["Error"];
|
|
1758
|
+
};
|
|
1759
|
+
};
|
|
1760
|
+
/** @description The key lacks the scope for this operation, the tenant is not active, or scene sessions are not enabled for the workspace — code "scene_sessions_not_enabled", a per-workspace preview gate. Contact support to opt in. */
|
|
1761
|
+
403: {
|
|
1762
|
+
headers: {
|
|
1763
|
+
[name: string]: unknown;
|
|
1764
|
+
};
|
|
1765
|
+
content: {
|
|
1766
|
+
"application/json": components["schemas"]["Error"];
|
|
1767
|
+
};
|
|
1768
|
+
};
|
|
1769
|
+
/** @description No scene with this id that this workspace prepared (code "scene_not_found") */
|
|
1770
|
+
404: {
|
|
1771
|
+
headers: {
|
|
1772
|
+
[name: string]: unknown;
|
|
1773
|
+
};
|
|
1774
|
+
content: {
|
|
1775
|
+
"application/json": components["schemas"]["Error"];
|
|
1776
|
+
};
|
|
1777
|
+
};
|
|
1778
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
1779
|
+
default: {
|
|
1780
|
+
headers: {
|
|
1781
|
+
[name: string]: unknown;
|
|
1782
|
+
};
|
|
1783
|
+
content: {
|
|
1784
|
+
"application/json": components["schemas"]["Error"];
|
|
1785
|
+
};
|
|
1786
|
+
};
|
|
1787
|
+
};
|
|
1788
|
+
};
|
|
1789
|
+
createSpeech: {
|
|
1790
|
+
parameters: {
|
|
1791
|
+
query?: never;
|
|
1792
|
+
header?: never;
|
|
1793
|
+
path: {
|
|
1794
|
+
voiceId: string;
|
|
1795
|
+
};
|
|
1796
|
+
cookie?: never;
|
|
1797
|
+
};
|
|
1798
|
+
requestBody: {
|
|
1799
|
+
content: {
|
|
1800
|
+
"application/json": components["schemas"]["CreateSpeechRequest"];
|
|
1801
|
+
};
|
|
1802
|
+
};
|
|
1803
|
+
responses: {
|
|
1804
|
+
/** @description The audio file, in the requested format. */
|
|
1805
|
+
200: {
|
|
1806
|
+
headers: {
|
|
1807
|
+
/** @description Credits billed for this request. */
|
|
1808
|
+
"X-RTA-Billed-Credits"?: number;
|
|
1809
|
+
/** @description UTF-8 bytes of the trimmed text that were metered. */
|
|
1810
|
+
"X-RTA-Billed-Bytes"?: number;
|
|
1811
|
+
[name: string]: unknown;
|
|
1812
|
+
};
|
|
1813
|
+
content: {
|
|
1814
|
+
"audio/mpeg": string;
|
|
1815
|
+
"audio/wav": string;
|
|
1816
|
+
};
|
|
1817
|
+
};
|
|
1818
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
1819
|
+
401: {
|
|
1820
|
+
headers: {
|
|
1821
|
+
[name: string]: unknown;
|
|
1822
|
+
};
|
|
1823
|
+
content: {
|
|
1824
|
+
"application/json": components["schemas"]["Error"];
|
|
1825
|
+
};
|
|
1826
|
+
};
|
|
1827
|
+
/** @description The key lacks the scope for this operation, the tenant is not active, or the workspace is not a paying one (code "speech_requires_purchase"). Speech is open to workspaces on a paid plan or that have bought credits; buying a credit pack unlocks it. */
|
|
1828
|
+
403: {
|
|
1829
|
+
headers: {
|
|
1830
|
+
[name: string]: unknown;
|
|
1831
|
+
};
|
|
1832
|
+
content: {
|
|
1833
|
+
"application/json": components["schemas"]["Error"];
|
|
1834
|
+
};
|
|
1835
|
+
};
|
|
1836
|
+
/** @description No voice with this id is available to this workspace (code "voice_not_found"). */
|
|
1837
|
+
404: {
|
|
1838
|
+
headers: {
|
|
1839
|
+
[name: string]: unknown;
|
|
1840
|
+
};
|
|
1841
|
+
content: {
|
|
1842
|
+
"application/json": components["schemas"]["Error"];
|
|
1843
|
+
};
|
|
1844
|
+
};
|
|
1845
|
+
/** @description The voice is still being prepared (code "voice_not_ready"). Retry shortly. */
|
|
1846
|
+
409: {
|
|
1847
|
+
headers: {
|
|
1848
|
+
[name: string]: unknown;
|
|
1849
|
+
};
|
|
1850
|
+
content: {
|
|
1851
|
+
"application/json": components["schemas"]["Error"];
|
|
1852
|
+
};
|
|
1853
|
+
};
|
|
1854
|
+
/** @description A request field or the voice id prefix is invalid; the voice cannot be used to generate speech (code "voice_unavailable"; choose another voice); the voice provider refused this request (code "speech_rejected"; check the text, format, speed and language); or the audio for this text is longer than one response can carry (code "speech_too_long"; split the text, or ask for mp3). None of these is retryable unchanged. */
|
|
1855
|
+
422: {
|
|
1856
|
+
headers: {
|
|
1857
|
+
[name: string]: unknown;
|
|
1858
|
+
};
|
|
1859
|
+
content: {
|
|
1860
|
+
"application/json": components["schemas"]["Error"];
|
|
1861
|
+
};
|
|
1862
|
+
};
|
|
1863
|
+
/** @description Per-workspace rate limit (code "rate_limited"), or speech generation is busy (code "speech_busy"): this workspace already has a request in progress, or the platform-wide cap is reached. Both are retryable; honour Retry-After. */
|
|
1864
|
+
429: {
|
|
1865
|
+
headers: {
|
|
1866
|
+
/** @description Seconds to wait before retrying. */
|
|
1867
|
+
"Retry-After"?: number;
|
|
1868
|
+
[name: string]: unknown;
|
|
1869
|
+
};
|
|
1870
|
+
content: {
|
|
1871
|
+
"application/json": components["schemas"]["Error"];
|
|
1872
|
+
};
|
|
1873
|
+
};
|
|
1874
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
1875
|
+
default: {
|
|
1876
|
+
headers: {
|
|
1877
|
+
[name: string]: unknown;
|
|
1878
|
+
};
|
|
1879
|
+
content: {
|
|
1880
|
+
"application/json": components["schemas"]["Error"];
|
|
1881
|
+
};
|
|
1882
|
+
};
|
|
1883
|
+
};
|
|
1884
|
+
};
|
|
1885
|
+
listAvatars: {
|
|
1886
|
+
parameters: {
|
|
1887
|
+
query?: never;
|
|
1888
|
+
header?: never;
|
|
1889
|
+
path?: never;
|
|
1890
|
+
cookie?: never;
|
|
1891
|
+
};
|
|
1892
|
+
requestBody?: never;
|
|
1893
|
+
responses: {
|
|
1894
|
+
/** @description Avatars */
|
|
1895
|
+
200: {
|
|
1896
|
+
headers: {
|
|
1897
|
+
[name: string]: unknown;
|
|
1898
|
+
};
|
|
1899
|
+
content: {
|
|
1900
|
+
"application/json": components["schemas"]["ListAvatarsResponse"];
|
|
1901
|
+
};
|
|
1902
|
+
};
|
|
1903
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
1904
|
+
401: {
|
|
1905
|
+
headers: {
|
|
1906
|
+
[name: string]: unknown;
|
|
1907
|
+
};
|
|
1908
|
+
content: {
|
|
1909
|
+
"application/json": components["schemas"]["Error"];
|
|
1910
|
+
};
|
|
1911
|
+
};
|
|
1912
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
1913
|
+
403: {
|
|
1914
|
+
headers: {
|
|
1915
|
+
[name: string]: unknown;
|
|
1916
|
+
};
|
|
1917
|
+
content: {
|
|
1918
|
+
"application/json": components["schemas"]["Error"];
|
|
1919
|
+
};
|
|
1920
|
+
};
|
|
1921
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
1922
|
+
default: {
|
|
1923
|
+
headers: {
|
|
1924
|
+
[name: string]: unknown;
|
|
1925
|
+
};
|
|
1926
|
+
content: {
|
|
1927
|
+
"application/json": components["schemas"]["Error"];
|
|
1928
|
+
};
|
|
1929
|
+
};
|
|
1930
|
+
};
|
|
1931
|
+
};
|
|
1932
|
+
createAvatar: {
|
|
1933
|
+
parameters: {
|
|
1934
|
+
query?: never;
|
|
1935
|
+
header?: never;
|
|
1936
|
+
path?: never;
|
|
1937
|
+
cookie?: never;
|
|
1938
|
+
};
|
|
1939
|
+
requestBody: {
|
|
1940
|
+
content: {
|
|
1941
|
+
"application/json": components["schemas"]["CreateAvatarRequest"];
|
|
1942
|
+
};
|
|
1943
|
+
};
|
|
1944
|
+
responses: {
|
|
1945
|
+
/** @description Created */
|
|
1946
|
+
201: {
|
|
1947
|
+
headers: {
|
|
1948
|
+
[name: string]: unknown;
|
|
1949
|
+
};
|
|
1950
|
+
content: {
|
|
1951
|
+
"application/json": components["schemas"]["Avatar"];
|
|
1952
|
+
};
|
|
1953
|
+
};
|
|
1954
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
1955
|
+
401: {
|
|
1956
|
+
headers: {
|
|
1957
|
+
[name: string]: unknown;
|
|
1958
|
+
};
|
|
1959
|
+
content: {
|
|
1960
|
+
"application/json": components["schemas"]["Error"];
|
|
1961
|
+
};
|
|
1962
|
+
};
|
|
1963
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
1964
|
+
403: {
|
|
1965
|
+
headers: {
|
|
1966
|
+
[name: string]: unknown;
|
|
1967
|
+
};
|
|
1968
|
+
content: {
|
|
1969
|
+
"application/json": components["schemas"]["Error"];
|
|
1970
|
+
};
|
|
1971
|
+
};
|
|
1972
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
1973
|
+
default: {
|
|
1974
|
+
headers: {
|
|
1975
|
+
[name: string]: unknown;
|
|
1976
|
+
};
|
|
1977
|
+
content: {
|
|
1978
|
+
"application/json": components["schemas"]["Error"];
|
|
1979
|
+
};
|
|
1980
|
+
};
|
|
1981
|
+
};
|
|
1982
|
+
};
|
|
1983
|
+
getAvatar: {
|
|
1984
|
+
parameters: {
|
|
1985
|
+
query?: never;
|
|
1986
|
+
header?: never;
|
|
1987
|
+
path: {
|
|
1988
|
+
avatarId: string;
|
|
1989
|
+
};
|
|
1990
|
+
cookie?: never;
|
|
1991
|
+
};
|
|
1992
|
+
requestBody?: never;
|
|
1993
|
+
responses: {
|
|
1994
|
+
/** @description Avatar */
|
|
1995
|
+
200: {
|
|
1996
|
+
headers: {
|
|
1997
|
+
[name: string]: unknown;
|
|
1998
|
+
};
|
|
1999
|
+
content: {
|
|
2000
|
+
"application/json": components["schemas"]["Avatar"];
|
|
2001
|
+
};
|
|
2002
|
+
};
|
|
2003
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2004
|
+
401: {
|
|
2005
|
+
headers: {
|
|
2006
|
+
[name: string]: unknown;
|
|
2007
|
+
};
|
|
2008
|
+
content: {
|
|
2009
|
+
"application/json": components["schemas"]["Error"];
|
|
2010
|
+
};
|
|
2011
|
+
};
|
|
2012
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2013
|
+
403: {
|
|
2014
|
+
headers: {
|
|
2015
|
+
[name: string]: unknown;
|
|
2016
|
+
};
|
|
2017
|
+
content: {
|
|
2018
|
+
"application/json": components["schemas"]["Error"];
|
|
2019
|
+
};
|
|
2020
|
+
};
|
|
2021
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2022
|
+
default: {
|
|
2023
|
+
headers: {
|
|
2024
|
+
[name: string]: unknown;
|
|
2025
|
+
};
|
|
2026
|
+
content: {
|
|
2027
|
+
"application/json": components["schemas"]["Error"];
|
|
2028
|
+
};
|
|
2029
|
+
};
|
|
2030
|
+
};
|
|
2031
|
+
};
|
|
2032
|
+
deleteAvatar: {
|
|
2033
|
+
parameters: {
|
|
2034
|
+
query?: never;
|
|
2035
|
+
header?: never;
|
|
2036
|
+
path: {
|
|
2037
|
+
avatarId: string;
|
|
2038
|
+
};
|
|
2039
|
+
cookie?: never;
|
|
2040
|
+
};
|
|
2041
|
+
requestBody?: never;
|
|
2042
|
+
responses: {
|
|
2043
|
+
/** @description Deleted. No content. */
|
|
2044
|
+
204: {
|
|
2045
|
+
headers: {
|
|
2046
|
+
[name: string]: unknown;
|
|
2047
|
+
};
|
|
2048
|
+
content?: never;
|
|
2049
|
+
};
|
|
2050
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2051
|
+
401: {
|
|
2052
|
+
headers: {
|
|
2053
|
+
[name: string]: unknown;
|
|
2054
|
+
};
|
|
2055
|
+
content: {
|
|
2056
|
+
"application/json": components["schemas"]["Error"];
|
|
2057
|
+
};
|
|
2058
|
+
};
|
|
2059
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2060
|
+
403: {
|
|
2061
|
+
headers: {
|
|
2062
|
+
[name: string]: unknown;
|
|
2063
|
+
};
|
|
2064
|
+
content: {
|
|
2065
|
+
"application/json": components["schemas"]["Error"];
|
|
2066
|
+
};
|
|
2067
|
+
};
|
|
2068
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2069
|
+
default: {
|
|
2070
|
+
headers: {
|
|
2071
|
+
[name: string]: unknown;
|
|
2072
|
+
};
|
|
2073
|
+
content: {
|
|
2074
|
+
"application/json": components["schemas"]["Error"];
|
|
2075
|
+
};
|
|
2076
|
+
};
|
|
2077
|
+
};
|
|
2078
|
+
};
|
|
2079
|
+
updateAvatar: {
|
|
2080
|
+
parameters: {
|
|
2081
|
+
query?: never;
|
|
2082
|
+
header?: never;
|
|
2083
|
+
path: {
|
|
2084
|
+
avatarId: string;
|
|
2085
|
+
};
|
|
2086
|
+
cookie?: never;
|
|
2087
|
+
};
|
|
2088
|
+
requestBody: {
|
|
2089
|
+
content: {
|
|
2090
|
+
"application/json": components["schemas"]["UpdateAvatarRequest"];
|
|
2091
|
+
};
|
|
2092
|
+
};
|
|
2093
|
+
responses: {
|
|
2094
|
+
/** @description Updated */
|
|
2095
|
+
200: {
|
|
2096
|
+
headers: {
|
|
2097
|
+
[name: string]: unknown;
|
|
2098
|
+
};
|
|
2099
|
+
content: {
|
|
2100
|
+
"application/json": components["schemas"]["Avatar"];
|
|
2101
|
+
};
|
|
2102
|
+
};
|
|
2103
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2104
|
+
401: {
|
|
2105
|
+
headers: {
|
|
2106
|
+
[name: string]: unknown;
|
|
2107
|
+
};
|
|
2108
|
+
content: {
|
|
2109
|
+
"application/json": components["schemas"]["Error"];
|
|
2110
|
+
};
|
|
2111
|
+
};
|
|
2112
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2113
|
+
403: {
|
|
2114
|
+
headers: {
|
|
2115
|
+
[name: string]: unknown;
|
|
2116
|
+
};
|
|
2117
|
+
content: {
|
|
2118
|
+
"application/json": components["schemas"]["Error"];
|
|
2119
|
+
};
|
|
2120
|
+
};
|
|
2121
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2122
|
+
default: {
|
|
2123
|
+
headers: {
|
|
2124
|
+
[name: string]: unknown;
|
|
2125
|
+
};
|
|
2126
|
+
content: {
|
|
2127
|
+
"application/json": components["schemas"]["Error"];
|
|
2128
|
+
};
|
|
2129
|
+
};
|
|
2130
|
+
};
|
|
2131
|
+
};
|
|
2132
|
+
listAvatarClips: {
|
|
2133
|
+
parameters: {
|
|
2134
|
+
query?: never;
|
|
2135
|
+
header?: never;
|
|
2136
|
+
path: {
|
|
2137
|
+
avatarId: string;
|
|
2138
|
+
};
|
|
2139
|
+
cookie?: never;
|
|
2140
|
+
};
|
|
2141
|
+
requestBody?: never;
|
|
2142
|
+
responses: {
|
|
2143
|
+
/** @description Clips */
|
|
2144
|
+
200: {
|
|
2145
|
+
headers: {
|
|
2146
|
+
[name: string]: unknown;
|
|
2147
|
+
};
|
|
2148
|
+
content: {
|
|
2149
|
+
"application/json": components["schemas"]["ListAvatarClipsResponse"];
|
|
2150
|
+
};
|
|
2151
|
+
};
|
|
2152
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2153
|
+
401: {
|
|
2154
|
+
headers: {
|
|
2155
|
+
[name: string]: unknown;
|
|
2156
|
+
};
|
|
2157
|
+
content: {
|
|
2158
|
+
"application/json": components["schemas"]["Error"];
|
|
2159
|
+
};
|
|
2160
|
+
};
|
|
2161
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2162
|
+
403: {
|
|
2163
|
+
headers: {
|
|
2164
|
+
[name: string]: unknown;
|
|
2165
|
+
};
|
|
2166
|
+
content: {
|
|
2167
|
+
"application/json": components["schemas"]["Error"];
|
|
2168
|
+
};
|
|
2169
|
+
};
|
|
2170
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2171
|
+
default: {
|
|
2172
|
+
headers: {
|
|
2173
|
+
[name: string]: unknown;
|
|
2174
|
+
};
|
|
2175
|
+
content: {
|
|
2176
|
+
"application/json": components["schemas"]["Error"];
|
|
2177
|
+
};
|
|
2178
|
+
};
|
|
2179
|
+
};
|
|
2180
|
+
};
|
|
2181
|
+
putAvatarClips: {
|
|
2182
|
+
parameters: {
|
|
2183
|
+
query?: never;
|
|
2184
|
+
header?: {
|
|
2185
|
+
/** @description Replays the original response byte-for-byte instead of performing the write again. Recommended on retries: a re-render is billed. Keys longer than 180 characters are IGNORED — the write proceeds without replay protection rather than failing — so keep it short. */
|
|
2186
|
+
"Idempotency-Key"?: string;
|
|
2187
|
+
};
|
|
2188
|
+
path: {
|
|
2189
|
+
avatarId: string;
|
|
2190
|
+
};
|
|
2191
|
+
cookie?: never;
|
|
2192
|
+
};
|
|
2193
|
+
requestBody: {
|
|
2194
|
+
content: {
|
|
2195
|
+
"application/json": components["schemas"]["PutAvatarClipsRequest"];
|
|
2196
|
+
};
|
|
2197
|
+
};
|
|
2198
|
+
responses: {
|
|
2199
|
+
/** @description Declaration accepted */
|
|
2200
|
+
202: {
|
|
2201
|
+
headers: {
|
|
2202
|
+
[name: string]: unknown;
|
|
2203
|
+
};
|
|
2204
|
+
content: {
|
|
2205
|
+
"application/json": components["schemas"]["PutAvatarClipsResponse"];
|
|
2206
|
+
};
|
|
2207
|
+
};
|
|
2208
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2209
|
+
401: {
|
|
2210
|
+
headers: {
|
|
2211
|
+
[name: string]: unknown;
|
|
2212
|
+
};
|
|
2213
|
+
content: {
|
|
2214
|
+
"application/json": components["schemas"]["Error"];
|
|
2215
|
+
};
|
|
2216
|
+
};
|
|
2217
|
+
/** @description The key lacks the scope for this operation, the tenant is not active, or clip-library editing has been disabled for the workspace — code "clip_library_not_enabled". Editing is enabled by default for active workspaces; an administrator may explicitly disable it. */
|
|
2218
|
+
403: {
|
|
2219
|
+
headers: {
|
|
2220
|
+
[name: string]: unknown;
|
|
2221
|
+
};
|
|
2222
|
+
content: {
|
|
2223
|
+
"application/json": components["schemas"]["Error"];
|
|
2224
|
+
};
|
|
2225
|
+
};
|
|
2226
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2227
|
+
default: {
|
|
2228
|
+
headers: {
|
|
2229
|
+
[name: string]: unknown;
|
|
2230
|
+
};
|
|
2231
|
+
content: {
|
|
2232
|
+
"application/json": components["schemas"]["Error"];
|
|
2233
|
+
};
|
|
2234
|
+
};
|
|
2235
|
+
};
|
|
2236
|
+
};
|
|
2237
|
+
reviewAvatarClip: {
|
|
2238
|
+
parameters: {
|
|
2239
|
+
query?: never;
|
|
2240
|
+
header?: never;
|
|
2241
|
+
path: {
|
|
2242
|
+
avatarId: string;
|
|
2243
|
+
};
|
|
2244
|
+
cookie?: never;
|
|
2245
|
+
};
|
|
2246
|
+
requestBody: {
|
|
2247
|
+
content: {
|
|
2248
|
+
"application/json": components["schemas"]["ReviewAvatarClipRequest"];
|
|
2249
|
+
};
|
|
2250
|
+
};
|
|
2251
|
+
responses: {
|
|
2252
|
+
/** @description Uploaded clip accepted; cache preparation scheduled */
|
|
2253
|
+
204: {
|
|
2254
|
+
headers: {
|
|
2255
|
+
[name: string]: unknown;
|
|
2256
|
+
};
|
|
2257
|
+
content?: never;
|
|
2258
|
+
};
|
|
2259
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2260
|
+
401: {
|
|
2261
|
+
headers: {
|
|
2262
|
+
[name: string]: unknown;
|
|
2263
|
+
};
|
|
2264
|
+
content: {
|
|
2265
|
+
"application/json": components["schemas"]["Error"];
|
|
2266
|
+
};
|
|
2267
|
+
};
|
|
2268
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2269
|
+
403: {
|
|
2270
|
+
headers: {
|
|
2271
|
+
[name: string]: unknown;
|
|
2272
|
+
};
|
|
2273
|
+
content: {
|
|
2274
|
+
"application/json": components["schemas"]["Error"];
|
|
2275
|
+
};
|
|
2276
|
+
};
|
|
2277
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2278
|
+
default: {
|
|
2279
|
+
headers: {
|
|
2280
|
+
[name: string]: unknown;
|
|
2281
|
+
};
|
|
2282
|
+
content: {
|
|
2283
|
+
"application/json": components["schemas"]["Error"];
|
|
2284
|
+
};
|
|
2285
|
+
};
|
|
2286
|
+
};
|
|
2287
|
+
};
|
|
2288
|
+
putAvatarLoop: {
|
|
2289
|
+
parameters: {
|
|
2290
|
+
query?: never;
|
|
2291
|
+
header?: {
|
|
2292
|
+
/** @description Replays the original response byte-for-byte instead of performing the write again. Recommended on retries: a re-render is billed. Keys longer than 180 characters are IGNORED — the write proceeds without replay protection rather than failing — so keep it short. */
|
|
2293
|
+
"Idempotency-Key"?: string;
|
|
2294
|
+
};
|
|
2295
|
+
path: {
|
|
2296
|
+
avatarId: string;
|
|
2297
|
+
};
|
|
2298
|
+
cookie?: never;
|
|
2299
|
+
};
|
|
2300
|
+
requestBody: {
|
|
2301
|
+
content: {
|
|
2302
|
+
"application/json": components["schemas"]["PutAvatarLoopRequest"];
|
|
2303
|
+
};
|
|
2304
|
+
};
|
|
2305
|
+
responses: {
|
|
2306
|
+
/** @description Re-direct accepted */
|
|
2307
|
+
202: {
|
|
2308
|
+
headers: {
|
|
2309
|
+
[name: string]: unknown;
|
|
2310
|
+
};
|
|
2311
|
+
content: {
|
|
2312
|
+
"application/json": components["schemas"]["PutAvatarLoopResponse"];
|
|
2313
|
+
};
|
|
2314
|
+
};
|
|
2315
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2316
|
+
401: {
|
|
2317
|
+
headers: {
|
|
2318
|
+
[name: string]: unknown;
|
|
2319
|
+
};
|
|
2320
|
+
content: {
|
|
2321
|
+
"application/json": components["schemas"]["Error"];
|
|
2322
|
+
};
|
|
2323
|
+
};
|
|
2324
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2325
|
+
403: {
|
|
2326
|
+
headers: {
|
|
2327
|
+
[name: string]: unknown;
|
|
2328
|
+
};
|
|
2329
|
+
content: {
|
|
2330
|
+
"application/json": components["schemas"]["Error"];
|
|
2331
|
+
};
|
|
2332
|
+
};
|
|
2333
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2334
|
+
default: {
|
|
2335
|
+
headers: {
|
|
2336
|
+
[name: string]: unknown;
|
|
2337
|
+
};
|
|
2338
|
+
content: {
|
|
2339
|
+
"application/json": components["schemas"]["Error"];
|
|
2340
|
+
};
|
|
2341
|
+
};
|
|
2342
|
+
};
|
|
2343
|
+
};
|
|
2344
|
+
createApiKey: {
|
|
2345
|
+
parameters: {
|
|
2346
|
+
query?: never;
|
|
2347
|
+
header?: never;
|
|
2348
|
+
path?: never;
|
|
2349
|
+
cookie?: never;
|
|
2350
|
+
};
|
|
2351
|
+
requestBody: {
|
|
2352
|
+
content: {
|
|
2353
|
+
"application/json": components["schemas"]["CreateApiKeyRequest"];
|
|
2354
|
+
};
|
|
2355
|
+
};
|
|
2356
|
+
responses: {
|
|
2357
|
+
/** @description Created. The plaintext key is returned on creation; workspace owners and admins can recover eligible keys in the dashboard. Recovery is not available through the developer API. */
|
|
2358
|
+
201: {
|
|
2359
|
+
headers: {
|
|
2360
|
+
[name: string]: unknown;
|
|
2361
|
+
};
|
|
2362
|
+
content: {
|
|
2363
|
+
"application/json": components["schemas"]["CreateApiKeyResponse"];
|
|
2364
|
+
};
|
|
2365
|
+
};
|
|
2366
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2367
|
+
401: {
|
|
2368
|
+
headers: {
|
|
2369
|
+
[name: string]: unknown;
|
|
2370
|
+
};
|
|
2371
|
+
content: {
|
|
2372
|
+
"application/json": components["schemas"]["Error"];
|
|
2373
|
+
};
|
|
2374
|
+
};
|
|
2375
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2376
|
+
403: {
|
|
2377
|
+
headers: {
|
|
2378
|
+
[name: string]: unknown;
|
|
2379
|
+
};
|
|
2380
|
+
content: {
|
|
2381
|
+
"application/json": components["schemas"]["Error"];
|
|
2382
|
+
};
|
|
2383
|
+
};
|
|
2384
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2385
|
+
default: {
|
|
2386
|
+
headers: {
|
|
2387
|
+
[name: string]: unknown;
|
|
2388
|
+
};
|
|
2389
|
+
content: {
|
|
2390
|
+
"application/json": components["schemas"]["Error"];
|
|
2391
|
+
};
|
|
2392
|
+
};
|
|
2393
|
+
};
|
|
2394
|
+
};
|
|
2395
|
+
listAssets: {
|
|
2396
|
+
parameters: {
|
|
2397
|
+
query?: never;
|
|
2398
|
+
header?: never;
|
|
2399
|
+
path?: never;
|
|
2400
|
+
cookie?: never;
|
|
2401
|
+
};
|
|
2402
|
+
requestBody?: never;
|
|
2403
|
+
responses: {
|
|
2404
|
+
/** @description Assets */
|
|
2405
|
+
200: {
|
|
2406
|
+
headers: {
|
|
2407
|
+
[name: string]: unknown;
|
|
2408
|
+
};
|
|
2409
|
+
content: {
|
|
2410
|
+
"application/json": components["schemas"]["AssetList"];
|
|
2411
|
+
};
|
|
2412
|
+
};
|
|
2413
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2414
|
+
401: {
|
|
2415
|
+
headers: {
|
|
2416
|
+
[name: string]: unknown;
|
|
2417
|
+
};
|
|
2418
|
+
content: {
|
|
2419
|
+
"application/json": components["schemas"]["Error"];
|
|
2420
|
+
};
|
|
2421
|
+
};
|
|
2422
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2423
|
+
403: {
|
|
2424
|
+
headers: {
|
|
2425
|
+
[name: string]: unknown;
|
|
2426
|
+
};
|
|
2427
|
+
content: {
|
|
2428
|
+
"application/json": components["schemas"]["Error"];
|
|
2429
|
+
};
|
|
2430
|
+
};
|
|
2431
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2432
|
+
default: {
|
|
2433
|
+
headers: {
|
|
2434
|
+
[name: string]: unknown;
|
|
2435
|
+
};
|
|
2436
|
+
content: {
|
|
2437
|
+
"application/json": components["schemas"]["Error"];
|
|
2438
|
+
};
|
|
2439
|
+
};
|
|
2440
|
+
};
|
|
2441
|
+
};
|
|
2442
|
+
uploadAsset: {
|
|
2443
|
+
parameters: {
|
|
2444
|
+
query?: never;
|
|
2445
|
+
header?: never;
|
|
2446
|
+
path?: never;
|
|
2447
|
+
cookie?: never;
|
|
2448
|
+
};
|
|
2449
|
+
requestBody: {
|
|
2450
|
+
content: {
|
|
2451
|
+
"multipart/form-data": {
|
|
2452
|
+
/**
|
|
2453
|
+
* Format: binary
|
|
2454
|
+
* @description The asset bytes.
|
|
2455
|
+
*/
|
|
2456
|
+
file: string;
|
|
2457
|
+
/**
|
|
2458
|
+
* @description Optional; inferred from the file when omitted. Image assets are portraits, audio assets are voice material, and video assets may be declared as uploaded motion clips with source.assetId. Video assets are not accepted as the source of a newly created Avatar.
|
|
2459
|
+
* @enum {string}
|
|
2460
|
+
*/
|
|
2461
|
+
kind?: "image" | "video" | "audio";
|
|
2462
|
+
};
|
|
2463
|
+
};
|
|
2464
|
+
};
|
|
2465
|
+
responses: {
|
|
2466
|
+
/** @description Uploaded */
|
|
2467
|
+
201: {
|
|
2468
|
+
headers: {
|
|
2469
|
+
[name: string]: unknown;
|
|
2470
|
+
};
|
|
2471
|
+
content: {
|
|
2472
|
+
"application/json": components["schemas"]["Asset"];
|
|
2473
|
+
};
|
|
2474
|
+
};
|
|
2475
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2476
|
+
401: {
|
|
2477
|
+
headers: {
|
|
2478
|
+
[name: string]: unknown;
|
|
2479
|
+
};
|
|
2480
|
+
content: {
|
|
2481
|
+
"application/json": components["schemas"]["Error"];
|
|
2482
|
+
};
|
|
2483
|
+
};
|
|
2484
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2485
|
+
403: {
|
|
2486
|
+
headers: {
|
|
2487
|
+
[name: string]: unknown;
|
|
2488
|
+
};
|
|
2489
|
+
content: {
|
|
2490
|
+
"application/json": components["schemas"]["Error"];
|
|
2491
|
+
};
|
|
2492
|
+
};
|
|
2493
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2494
|
+
default: {
|
|
2495
|
+
headers: {
|
|
2496
|
+
[name: string]: unknown;
|
|
2497
|
+
};
|
|
2498
|
+
content: {
|
|
2499
|
+
"application/json": components["schemas"]["Error"];
|
|
2500
|
+
};
|
|
2501
|
+
};
|
|
2502
|
+
};
|
|
2503
|
+
};
|
|
2504
|
+
createRemoteAsset: {
|
|
2505
|
+
parameters: {
|
|
2506
|
+
query?: never;
|
|
2507
|
+
header?: never;
|
|
2508
|
+
path?: never;
|
|
2509
|
+
cookie?: never;
|
|
2510
|
+
};
|
|
2511
|
+
requestBody: {
|
|
2512
|
+
content: {
|
|
2513
|
+
"application/json": components["schemas"]["CreateRemoteAssetRequest"];
|
|
2514
|
+
};
|
|
2515
|
+
};
|
|
2516
|
+
responses: {
|
|
2517
|
+
/** @description Created */
|
|
2518
|
+
201: {
|
|
2519
|
+
headers: {
|
|
2520
|
+
[name: string]: unknown;
|
|
2521
|
+
};
|
|
2522
|
+
content: {
|
|
2523
|
+
"application/json": components["schemas"]["Asset"];
|
|
2524
|
+
};
|
|
2525
|
+
};
|
|
2526
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2527
|
+
401: {
|
|
2528
|
+
headers: {
|
|
2529
|
+
[name: string]: unknown;
|
|
2530
|
+
};
|
|
2531
|
+
content: {
|
|
2532
|
+
"application/json": components["schemas"]["Error"];
|
|
2533
|
+
};
|
|
2534
|
+
};
|
|
2535
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2536
|
+
403: {
|
|
2537
|
+
headers: {
|
|
2538
|
+
[name: string]: unknown;
|
|
2539
|
+
};
|
|
2540
|
+
content: {
|
|
2541
|
+
"application/json": components["schemas"]["Error"];
|
|
2542
|
+
};
|
|
2543
|
+
};
|
|
2544
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2545
|
+
default: {
|
|
2546
|
+
headers: {
|
|
2547
|
+
[name: string]: unknown;
|
|
2548
|
+
};
|
|
2549
|
+
content: {
|
|
2550
|
+
"application/json": components["schemas"]["Error"];
|
|
2551
|
+
};
|
|
2552
|
+
};
|
|
2553
|
+
};
|
|
2554
|
+
};
|
|
2555
|
+
getCreditBalance: {
|
|
2556
|
+
parameters: {
|
|
2557
|
+
query?: never;
|
|
2558
|
+
header?: never;
|
|
2559
|
+
path?: never;
|
|
2560
|
+
cookie?: never;
|
|
2561
|
+
};
|
|
2562
|
+
requestBody?: never;
|
|
2563
|
+
responses: {
|
|
2564
|
+
/** @description Balance */
|
|
2565
|
+
200: {
|
|
2566
|
+
headers: {
|
|
2567
|
+
[name: string]: unknown;
|
|
2568
|
+
};
|
|
2569
|
+
content: {
|
|
2570
|
+
"application/json": components["schemas"]["CreditBalance"];
|
|
2571
|
+
};
|
|
2572
|
+
};
|
|
2573
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2574
|
+
401: {
|
|
2575
|
+
headers: {
|
|
2576
|
+
[name: string]: unknown;
|
|
2577
|
+
};
|
|
2578
|
+
content: {
|
|
2579
|
+
"application/json": components["schemas"]["Error"];
|
|
2580
|
+
};
|
|
2581
|
+
};
|
|
2582
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2583
|
+
403: {
|
|
2584
|
+
headers: {
|
|
2585
|
+
[name: string]: unknown;
|
|
2586
|
+
};
|
|
2587
|
+
content: {
|
|
2588
|
+
"application/json": components["schemas"]["Error"];
|
|
2589
|
+
};
|
|
2590
|
+
};
|
|
2591
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2592
|
+
default: {
|
|
2593
|
+
headers: {
|
|
2594
|
+
[name: string]: unknown;
|
|
2595
|
+
};
|
|
2596
|
+
content: {
|
|
2597
|
+
"application/json": components["schemas"]["Error"];
|
|
2598
|
+
};
|
|
2599
|
+
};
|
|
2600
|
+
};
|
|
2601
|
+
};
|
|
2602
|
+
getConnectionHistory: {
|
|
2603
|
+
parameters: {
|
|
2604
|
+
query?: never;
|
|
2605
|
+
header?: never;
|
|
2606
|
+
path: {
|
|
2607
|
+
sessionId: string;
|
|
2608
|
+
};
|
|
2609
|
+
cookie?: never;
|
|
2610
|
+
};
|
|
2611
|
+
requestBody?: never;
|
|
2612
|
+
responses: {
|
|
2613
|
+
/** @description Session connection history */
|
|
2614
|
+
200: {
|
|
2615
|
+
headers: {
|
|
2616
|
+
[name: string]: unknown;
|
|
2617
|
+
};
|
|
2618
|
+
content: {
|
|
2619
|
+
"application/json": components["schemas"]["ConnectionHistoryResponse"];
|
|
2620
|
+
};
|
|
2621
|
+
};
|
|
2622
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2623
|
+
401: {
|
|
2624
|
+
headers: {
|
|
2625
|
+
[name: string]: unknown;
|
|
2626
|
+
};
|
|
2627
|
+
content: {
|
|
2628
|
+
"application/json": components["schemas"]["Error"];
|
|
2629
|
+
};
|
|
2630
|
+
};
|
|
2631
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2632
|
+
403: {
|
|
2633
|
+
headers: {
|
|
2634
|
+
[name: string]: unknown;
|
|
2635
|
+
};
|
|
2636
|
+
content: {
|
|
2637
|
+
"application/json": components["schemas"]["Error"];
|
|
2638
|
+
};
|
|
2639
|
+
};
|
|
2640
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2641
|
+
default: {
|
|
2642
|
+
headers: {
|
|
2643
|
+
[name: string]: unknown;
|
|
2644
|
+
};
|
|
2645
|
+
content: {
|
|
2646
|
+
"application/json": components["schemas"]["Error"];
|
|
2647
|
+
};
|
|
2648
|
+
};
|
|
2649
|
+
};
|
|
2650
|
+
};
|
|
2651
|
+
listRecordings: {
|
|
2652
|
+
parameters: {
|
|
2653
|
+
query?: {
|
|
2654
|
+
/** @description Filter to one session. */
|
|
2655
|
+
sessionId?: string;
|
|
2656
|
+
limit?: number;
|
|
2657
|
+
/** @description The previous response's nextCursor. */
|
|
2658
|
+
cursor?: string;
|
|
2659
|
+
};
|
|
2660
|
+
header?: never;
|
|
2661
|
+
path?: never;
|
|
2662
|
+
cookie?: never;
|
|
2663
|
+
};
|
|
2664
|
+
requestBody?: never;
|
|
2665
|
+
responses: {
|
|
2666
|
+
/** @description Recordings */
|
|
2667
|
+
200: {
|
|
2668
|
+
headers: {
|
|
2669
|
+
[name: string]: unknown;
|
|
2670
|
+
};
|
|
2671
|
+
content: {
|
|
2672
|
+
"application/json": components["schemas"]["ListRecordingsResponse"];
|
|
2673
|
+
};
|
|
2674
|
+
};
|
|
2675
|
+
/** @description Invalid query */
|
|
2676
|
+
400: {
|
|
2677
|
+
headers: {
|
|
2678
|
+
[name: string]: unknown;
|
|
2679
|
+
};
|
|
2680
|
+
content: {
|
|
2681
|
+
"application/json": components["schemas"]["Error"];
|
|
2682
|
+
};
|
|
2683
|
+
};
|
|
2684
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2685
|
+
401: {
|
|
2686
|
+
headers: {
|
|
2687
|
+
[name: string]: unknown;
|
|
2688
|
+
};
|
|
2689
|
+
content: {
|
|
2690
|
+
"application/json": components["schemas"]["Error"];
|
|
2691
|
+
};
|
|
2692
|
+
};
|
|
2693
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2694
|
+
403: {
|
|
2695
|
+
headers: {
|
|
2696
|
+
[name: string]: unknown;
|
|
2697
|
+
};
|
|
2698
|
+
content: {
|
|
2699
|
+
"application/json": components["schemas"]["Error"];
|
|
2700
|
+
};
|
|
2701
|
+
};
|
|
2702
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2703
|
+
default: {
|
|
2704
|
+
headers: {
|
|
2705
|
+
[name: string]: unknown;
|
|
2706
|
+
};
|
|
2707
|
+
content: {
|
|
2708
|
+
"application/json": components["schemas"]["Error"];
|
|
2709
|
+
};
|
|
2710
|
+
};
|
|
2711
|
+
};
|
|
2712
|
+
};
|
|
2713
|
+
getRecording: {
|
|
2714
|
+
parameters: {
|
|
2715
|
+
query?: never;
|
|
2716
|
+
header?: never;
|
|
2717
|
+
path: {
|
|
2718
|
+
recordingId: string;
|
|
2719
|
+
};
|
|
2720
|
+
cookie?: never;
|
|
2721
|
+
};
|
|
2722
|
+
requestBody?: never;
|
|
2723
|
+
responses: {
|
|
2724
|
+
/** @description Recording */
|
|
2725
|
+
200: {
|
|
2726
|
+
headers: {
|
|
2727
|
+
[name: string]: unknown;
|
|
2728
|
+
};
|
|
2729
|
+
content: {
|
|
2730
|
+
"application/json": components["schemas"]["Recording"];
|
|
2731
|
+
};
|
|
2732
|
+
};
|
|
2733
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2734
|
+
401: {
|
|
2735
|
+
headers: {
|
|
2736
|
+
[name: string]: unknown;
|
|
2737
|
+
};
|
|
2738
|
+
content: {
|
|
2739
|
+
"application/json": components["schemas"]["Error"];
|
|
2740
|
+
};
|
|
2741
|
+
};
|
|
2742
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2743
|
+
403: {
|
|
2744
|
+
headers: {
|
|
2745
|
+
[name: string]: unknown;
|
|
2746
|
+
};
|
|
2747
|
+
content: {
|
|
2748
|
+
"application/json": components["schemas"]["Error"];
|
|
2749
|
+
};
|
|
2750
|
+
};
|
|
2751
|
+
/** @description Recording not found in this workspace */
|
|
2752
|
+
404: {
|
|
2753
|
+
headers: {
|
|
2754
|
+
[name: string]: unknown;
|
|
2755
|
+
};
|
|
2756
|
+
content: {
|
|
2757
|
+
"application/json": components["schemas"]["Error"];
|
|
2758
|
+
};
|
|
2759
|
+
};
|
|
2760
|
+
/** @description Recording status temporarily unavailable */
|
|
2761
|
+
503: {
|
|
2762
|
+
headers: {
|
|
2763
|
+
[name: string]: unknown;
|
|
2764
|
+
};
|
|
2765
|
+
content: {
|
|
2766
|
+
"application/json": components["schemas"]["Error"];
|
|
2767
|
+
};
|
|
2768
|
+
};
|
|
2769
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2770
|
+
default: {
|
|
2771
|
+
headers: {
|
|
2772
|
+
[name: string]: unknown;
|
|
2773
|
+
};
|
|
2774
|
+
content: {
|
|
2775
|
+
"application/json": components["schemas"]["Error"];
|
|
2776
|
+
};
|
|
2777
|
+
};
|
|
2778
|
+
};
|
|
2779
|
+
};
|
|
2780
|
+
getRecordingAccess: {
|
|
2781
|
+
parameters: {
|
|
2782
|
+
query?: never;
|
|
2783
|
+
header?: never;
|
|
2784
|
+
path: {
|
|
2785
|
+
recordingId: string;
|
|
2786
|
+
};
|
|
2787
|
+
cookie?: never;
|
|
2788
|
+
};
|
|
2789
|
+
requestBody?: never;
|
|
2790
|
+
responses: {
|
|
2791
|
+
/** @description Temporary access */
|
|
2792
|
+
200: {
|
|
2793
|
+
headers: {
|
|
2794
|
+
[name: string]: unknown;
|
|
2795
|
+
};
|
|
2796
|
+
content: {
|
|
2797
|
+
"application/json": components["schemas"]["RecordingAccessResponse"];
|
|
2798
|
+
};
|
|
2799
|
+
};
|
|
2800
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2801
|
+
401: {
|
|
2802
|
+
headers: {
|
|
2803
|
+
[name: string]: unknown;
|
|
2804
|
+
};
|
|
2805
|
+
content: {
|
|
2806
|
+
"application/json": components["schemas"]["Error"];
|
|
2807
|
+
};
|
|
2808
|
+
};
|
|
2809
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2810
|
+
403: {
|
|
2811
|
+
headers: {
|
|
2812
|
+
[name: string]: unknown;
|
|
2813
|
+
};
|
|
2814
|
+
content: {
|
|
2815
|
+
"application/json": components["schemas"]["Error"];
|
|
2816
|
+
};
|
|
2817
|
+
};
|
|
2818
|
+
/** @description Recording not found in this workspace */
|
|
2819
|
+
404: {
|
|
2820
|
+
headers: {
|
|
2821
|
+
[name: string]: unknown;
|
|
2822
|
+
};
|
|
2823
|
+
content: {
|
|
2824
|
+
"application/json": components["schemas"]["Error"];
|
|
2825
|
+
};
|
|
2826
|
+
};
|
|
2827
|
+
/** @description Recording not ready */
|
|
2828
|
+
409: {
|
|
2829
|
+
headers: {
|
|
2830
|
+
[name: string]: unknown;
|
|
2831
|
+
};
|
|
2832
|
+
content: {
|
|
2833
|
+
"application/json": components["schemas"]["Error"];
|
|
2834
|
+
};
|
|
2835
|
+
};
|
|
2836
|
+
/** @description Recording retention expired */
|
|
2837
|
+
410: {
|
|
2838
|
+
headers: {
|
|
2839
|
+
[name: string]: unknown;
|
|
2840
|
+
};
|
|
2841
|
+
content: {
|
|
2842
|
+
"application/json": components["schemas"]["Error"];
|
|
2843
|
+
};
|
|
2844
|
+
};
|
|
2845
|
+
/** @description Recording media temporarily unavailable */
|
|
2846
|
+
503: {
|
|
2847
|
+
headers: {
|
|
2848
|
+
[name: string]: unknown;
|
|
2849
|
+
};
|
|
2850
|
+
content: {
|
|
2851
|
+
"application/json": components["schemas"]["Error"];
|
|
2852
|
+
};
|
|
2853
|
+
};
|
|
2854
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2855
|
+
default: {
|
|
2856
|
+
headers: {
|
|
2857
|
+
[name: string]: unknown;
|
|
2858
|
+
};
|
|
2859
|
+
content: {
|
|
2860
|
+
"application/json": components["schemas"]["Error"];
|
|
2861
|
+
};
|
|
2862
|
+
};
|
|
2863
|
+
};
|
|
2864
|
+
};
|
|
2865
|
+
listUsageSessions: {
|
|
2866
|
+
parameters: {
|
|
2867
|
+
query?: {
|
|
2868
|
+
/** @description Start of the window. Defaults to 30 days before `to`; clamped to no earlier than 90 days before it. */
|
|
2869
|
+
from?: string;
|
|
2870
|
+
/** @description End of the window. Defaults to now. */
|
|
2871
|
+
to?: string;
|
|
2872
|
+
/** @description Rows per page. Defaults to 50, clamped to 1–200; with X-RTA-Speech-Diagnostics: 1 clamped to 1–50. Read the actual returned rows and nextCursor. */
|
|
2873
|
+
limit?: number;
|
|
2874
|
+
/** @description Opaque cursor — pass the previous response's `nextCursor` verbatim. A null `nextCursor` means the last page. */
|
|
2875
|
+
cursor?: string;
|
|
2876
|
+
/** @description Narrow to one of YOUR users — matches the `client_metadata.user_id` the call was minted with. Untagged calls still return, with empty metadata. */
|
|
2877
|
+
endUserId?: string;
|
|
2878
|
+
};
|
|
2879
|
+
header?: {
|
|
2880
|
+
/** @description Send 1 to include optional session-bound releaseIdentity in this response. Without this opt-in the field is omitted for strict client compatibility. Capture and storage are independent of this header; missing evidence remains null. Older servers may ignore this header. */
|
|
2881
|
+
"X-RTA-Release-Evidence"?: "1";
|
|
2882
|
+
/** @description Send exactly 1 to include numeric closed dialogue speechDiagnostics. Otherwise omitted and no summary reads occur. Opt-in pages clamp to 50 rows with normal keyset pagination; each row has explicit availability. Whole-session cohorts, not query-time slices or pooled turn percentiles. Summary budget 65536 bytes, total page deadline 5000 ms, concurrency 4. Older servers may ignore this header. */
|
|
2883
|
+
"X-RTA-Speech-Diagnostics"?: "1";
|
|
2884
|
+
};
|
|
2885
|
+
path?: never;
|
|
2886
|
+
cookie?: never;
|
|
2887
|
+
};
|
|
2888
|
+
requestBody?: never;
|
|
2889
|
+
responses: {
|
|
2890
|
+
/** @description Sessions */
|
|
2891
|
+
200: {
|
|
2892
|
+
headers: {
|
|
2893
|
+
[name: string]: unknown;
|
|
2894
|
+
};
|
|
2895
|
+
content: {
|
|
2896
|
+
"application/json": components["schemas"]["ListUsageSessionsResponse"];
|
|
2897
|
+
};
|
|
2898
|
+
};
|
|
2899
|
+
/** @description Missing, malformed, revoked, or expired key. */
|
|
2900
|
+
401: {
|
|
2901
|
+
headers: {
|
|
2902
|
+
[name: string]: unknown;
|
|
2903
|
+
};
|
|
2904
|
+
content: {
|
|
2905
|
+
"application/json": components["schemas"]["Error"];
|
|
2906
|
+
};
|
|
2907
|
+
};
|
|
2908
|
+
/** @description The key lacks the scope for this operation, or the tenant is not active. */
|
|
2909
|
+
403: {
|
|
2910
|
+
headers: {
|
|
2911
|
+
[name: string]: unknown;
|
|
2912
|
+
};
|
|
2913
|
+
content: {
|
|
2914
|
+
"application/json": components["schemas"]["Error"];
|
|
2915
|
+
};
|
|
2916
|
+
};
|
|
2917
|
+
/** @description Error. Route-dependent: 400 (a field this route cannot honour — see `portraitUrl` on `UpdateAvatarRequest`), 402 (insufficient credits or spend limit), 404 (no such avatar, voice, or key for this tenant — the message often reads "does not belong to this tenant", which is a missing id and not a permission failure), 408 (the request was cancelled), 409 (the resource is not in a state that accepts this write — a stale `expectedRevision`, a render already in flight, or a mint that asked for a clip library still building), 411 (`POST /v1/assets/remote` only — the origin serving `remoteUrl` sent no `content-length`, so the platform will not stream it), 422 (strict schema rejection, or a motion description the safety screen refused), 429 (rate limited), 502 (upstream render failed), 503 (a dependency this route needs is unavailable — retryable, and nothing was written), 504 (the upstream request budget expired), 500 (unhandled). Switch on `code` where present, else `status`. */
|
|
2918
|
+
default: {
|
|
2919
|
+
headers: {
|
|
2920
|
+
[name: string]: unknown;
|
|
2921
|
+
};
|
|
2922
|
+
content: {
|
|
2923
|
+
"application/json": components["schemas"]["Error"];
|
|
2924
|
+
};
|
|
2925
|
+
};
|
|
2926
|
+
};
|
|
2927
|
+
};
|
|
2928
|
+
receiveSessionTranscript: {
|
|
2929
|
+
parameters: {
|
|
2930
|
+
query?: never;
|
|
2931
|
+
header: {
|
|
2932
|
+
/** @description v1= followed by the hex HMAC-SHA256 of <timestamp>.<raw body>, keyed by transcript_webhook.secret. Compare in constant time. */
|
|
2933
|
+
"x-rta-signature": string;
|
|
2934
|
+
/** @description Timestamp string used verbatim in the signed message. Verify freshness to bound replay. */
|
|
2935
|
+
"x-rta-timestamp": string;
|
|
2936
|
+
};
|
|
2937
|
+
path?: never;
|
|
2938
|
+
cookie?: never;
|
|
2939
|
+
};
|
|
2940
|
+
requestBody: {
|
|
2941
|
+
content: {
|
|
2942
|
+
"application/json": components["schemas"]["TranscriptPayload"];
|
|
2943
|
+
};
|
|
2944
|
+
};
|
|
2945
|
+
responses: {
|
|
2946
|
+
/** @description Receipt acknowledged by the application. */
|
|
2947
|
+
"2XX": {
|
|
2948
|
+
headers: {
|
|
2949
|
+
[name: string]: unknown;
|
|
2950
|
+
};
|
|
2951
|
+
content?: never;
|
|
2952
|
+
};
|
|
2953
|
+
/** @description Application response; delivery and retries are best-effort. */
|
|
2954
|
+
default: {
|
|
2955
|
+
headers: {
|
|
2956
|
+
[name: string]: unknown;
|
|
2957
|
+
};
|
|
2958
|
+
content?: never;
|
|
2959
|
+
};
|
|
2960
|
+
};
|
|
2961
|
+
};
|
|
2962
|
+
synthesizeVoice: {
|
|
2963
|
+
parameters: {
|
|
2964
|
+
query?: never;
|
|
2965
|
+
header: {
|
|
2966
|
+
/** @description v1= followed by the hex HMAC-SHA256 of <timestamp>.<raw body>, keyed by voice_webhook.secret. Compare in constant time. */
|
|
2967
|
+
"x-rta-signature": string;
|
|
2968
|
+
/** @description Unix seconds, used verbatim in the signed message. Verify freshness to bound replay. */
|
|
2969
|
+
"x-rta-timestamp": string;
|
|
2970
|
+
/** @description Equal to request_id in the body. Unique per POST. */
|
|
2971
|
+
"x-rta-request-id": string;
|
|
2972
|
+
};
|
|
2973
|
+
path?: never;
|
|
2974
|
+
cookie?: never;
|
|
2975
|
+
};
|
|
2976
|
+
requestBody: {
|
|
2977
|
+
content: {
|
|
2978
|
+
"application/json": components["schemas"]["VoiceWebhookRequest"];
|
|
2979
|
+
};
|
|
2980
|
+
};
|
|
2981
|
+
responses: {
|
|
2982
|
+
/** @description Speech audio for request.text, streamed. */
|
|
2983
|
+
200: {
|
|
2984
|
+
headers: {
|
|
2985
|
+
[name: string]: unknown;
|
|
2986
|
+
};
|
|
2987
|
+
content: {
|
|
2988
|
+
"audio/pcm": string;
|
|
2989
|
+
"audio/wav": string;
|
|
2990
|
+
"audio/mpeg": string;
|
|
2991
|
+
"audio/ogg": string;
|
|
2992
|
+
};
|
|
2993
|
+
};
|
|
2994
|
+
/** @description No audio: voice_webhook_empty_audio, as is any 2xx with no body. The rest of that reply is dropped. */
|
|
2995
|
+
204: {
|
|
2996
|
+
headers: {
|
|
2997
|
+
[name: string]: unknown;
|
|
2998
|
+
};
|
|
2999
|
+
content?: never;
|
|
3000
|
+
};
|
|
3001
|
+
/** @description Signature rejected. Ends the call with voice_webhook_unauthorized. */
|
|
3002
|
+
401: {
|
|
3003
|
+
headers: {
|
|
3004
|
+
[name: string]: unknown;
|
|
3005
|
+
};
|
|
3006
|
+
content?: never;
|
|
3007
|
+
};
|
|
3008
|
+
/** @description Refused. Ends the call with voice_webhook_unauthorized. */
|
|
3009
|
+
403: {
|
|
3010
|
+
headers: {
|
|
3011
|
+
[name: string]: unknown;
|
|
3012
|
+
};
|
|
3013
|
+
content?: never;
|
|
3014
|
+
};
|
|
3015
|
+
/** @description Any other status, a 3xx included, is voice_webhook_http_error. Statuses 408, 429 and 5xx are retried once, as a new POST with a new request_id; any other status, or a failed retry, drops the rest of that reply. */
|
|
3016
|
+
default: {
|
|
3017
|
+
headers: {
|
|
3018
|
+
[name: string]: unknown;
|
|
3019
|
+
};
|
|
3020
|
+
content?: never;
|
|
3021
|
+
};
|
|
3022
|
+
};
|
|
3023
|
+
};
|
|
3024
|
+
}
|
|
3025
|
+
|
|
3026
|
+
declare const listUsageSessionsResponseSchema: z.ZodObject<{
|
|
3027
|
+
data: z.ZodArray<z.ZodObject<{
|
|
3028
|
+
sessionId: z.ZodString;
|
|
3029
|
+
speechDiagnostics: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
|
|
3030
|
+
latency_ms: z.ZodRecord<z.ZodUnion<readonly [z.ZodEnum<{
|
|
3031
|
+
llm: "llm";
|
|
3032
|
+
eou: "eou";
|
|
3033
|
+
tts: "tts";
|
|
3034
|
+
decision: "decision";
|
|
3035
|
+
hold: "hold";
|
|
3036
|
+
e2e: "e2e";
|
|
3037
|
+
}>, z.ZodLiteral<"interrupt_stop">]> & z.core.$partial, z.ZodObject<{
|
|
3038
|
+
count: z.ZodInt;
|
|
3039
|
+
max: z.ZodNumber;
|
|
3040
|
+
p50: z.ZodNumber;
|
|
3041
|
+
p90: z.ZodNumber;
|
|
3042
|
+
}, z.core.$strict>>;
|
|
3043
|
+
status: z.ZodLiteral<"available">;
|
|
3044
|
+
sourceRole: z.ZodLiteral<"dialogue">;
|
|
3045
|
+
coverage: z.ZodObject<{
|
|
3046
|
+
first_at: z.ZodUnion<readonly [z.ZodString, z.ZodNull]>;
|
|
3047
|
+
last_at: z.ZodUnion<readonly [z.ZodString, z.ZodNull]>;
|
|
3048
|
+
lines: z.ZodInt;
|
|
3049
|
+
}, z.core.$strict>;
|
|
3050
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
3051
|
+
status: z.ZodLiteral<"unavailable">;
|
|
3052
|
+
reason: z.ZodEnum<{
|
|
3053
|
+
not_closed: "not_closed";
|
|
3054
|
+
unconfigured: "unconfigured";
|
|
3055
|
+
missing: "missing";
|
|
3056
|
+
invalid: "invalid";
|
|
3057
|
+
oversized: "oversized";
|
|
3058
|
+
unscorable: "unscorable";
|
|
3059
|
+
no_measured_latency: "no_measured_latency";
|
|
3060
|
+
timeout: "timeout";
|
|
3061
|
+
aborted: "aborted";
|
|
3062
|
+
storage_unavailable: "storage_unavailable";
|
|
3063
|
+
}>;
|
|
3064
|
+
}, z.core.$strict>]>>;
|
|
3065
|
+
releaseIdentity: z.ZodOptional<z.ZodObject<{
|
|
3066
|
+
deploymentId: z.ZodUnion<readonly [z.ZodString, z.ZodNull]>;
|
|
3067
|
+
workerRevision: z.ZodUnion<readonly [z.ZodString, z.ZodNull]>;
|
|
3068
|
+
provenance: z.ZodObject<{
|
|
3069
|
+
deploymentSource: z.ZodLiteral<"cloudflare-worker-version">;
|
|
3070
|
+
workerSource: z.ZodUnion<readonly [z.ZodLiteral<"authenticated-worker-heartbeat">, z.ZodNull]>;
|
|
3071
|
+
workerId: z.ZodUnion<readonly [z.ZodString, z.ZodNull]>;
|
|
3072
|
+
podStartedAtMs: z.ZodUnion<readonly [z.ZodInt, z.ZodNull]>;
|
|
3073
|
+
workerObservedAt: z.ZodUnion<readonly [z.ZodISODateTime, z.ZodNull]>;
|
|
3074
|
+
}, z.core.$strict>;
|
|
3075
|
+
}, z.core.$strict>>;
|
|
3076
|
+
avatarId: z.ZodUnion<readonly [z.ZodString, z.ZodNull]>;
|
|
3077
|
+
avatarName: z.ZodUnion<readonly [z.ZodString, z.ZodNull]>;
|
|
3078
|
+
status: z.ZodEnum<{
|
|
3079
|
+
failed: "failed";
|
|
3080
|
+
reserved: "reserved";
|
|
3081
|
+
started: "started";
|
|
3082
|
+
released: "released";
|
|
3083
|
+
}>;
|
|
3084
|
+
startedAt: z.ZodUnion<readonly [z.ZodString, z.ZodNull]>;
|
|
3085
|
+
endedAt: z.ZodUnion<readonly [z.ZodString, z.ZodNull]>;
|
|
3086
|
+
activeSeconds: z.ZodUnion<readonly [z.ZodNumber, z.ZodNull]>;
|
|
3087
|
+
billedCreditMicros: z.ZodUnion<readonly [z.ZodInt, z.ZodNull]>;
|
|
3088
|
+
metadata: z.ZodCustom<Record<string, unknown>, Record<string, unknown>>;
|
|
3089
|
+
createdAt: z.ZodString;
|
|
3090
|
+
}, z.core.$strict>>;
|
|
3091
|
+
nextCursor: z.ZodUnion<readonly [z.ZodString, z.ZodNull]>;
|
|
3092
|
+
from: z.ZodISODateTime;
|
|
3093
|
+
to: z.ZodISODateTime;
|
|
3094
|
+
}, z.core.$strict>;
|
|
3095
|
+
declare function toSessionsPage(page: z.infer<typeof listUsageSessionsResponseSchema>): {
|
|
3096
|
+
sessions: {
|
|
3097
|
+
sessionId: string;
|
|
3098
|
+
avatarId: string | null;
|
|
3099
|
+
avatarName: string | null;
|
|
3100
|
+
status: "failed" | "reserved" | "started" | "released";
|
|
3101
|
+
startedAt: string | null;
|
|
3102
|
+
endedAt: string | null;
|
|
3103
|
+
activeSeconds: number | null;
|
|
3104
|
+
billedCreditMicros: number | null;
|
|
3105
|
+
metadata: Record<string, unknown>;
|
|
3106
|
+
createdAt: string;
|
|
3107
|
+
speechDiagnostics?: {
|
|
3108
|
+
latency_ms: Partial<Record<"llm" | "eou" | "tts" | "decision" | "hold" | "e2e" | "interrupt_stop", {
|
|
3109
|
+
count: number;
|
|
3110
|
+
max: number;
|
|
3111
|
+
p50: number;
|
|
3112
|
+
p90: number;
|
|
3113
|
+
}>>;
|
|
3114
|
+
status: "available";
|
|
3115
|
+
sourceRole: "dialogue";
|
|
3116
|
+
coverage: {
|
|
3117
|
+
first_at: string | null;
|
|
3118
|
+
last_at: string | null;
|
|
3119
|
+
lines: number;
|
|
3120
|
+
};
|
|
3121
|
+
} | {
|
|
3122
|
+
status: "unavailable";
|
|
3123
|
+
reason: "not_closed" | "unconfigured" | "missing" | "invalid" | "oversized" | "unscorable" | "no_measured_latency" | "timeout" | "aborted" | "storage_unavailable";
|
|
3124
|
+
} | undefined;
|
|
3125
|
+
releaseIdentity?: {
|
|
3126
|
+
deploymentId: string | null;
|
|
3127
|
+
workerRevision: string | null;
|
|
3128
|
+
provenance: {
|
|
3129
|
+
deploymentSource: "cloudflare-worker-version";
|
|
3130
|
+
workerSource: "authenticated-worker-heartbeat" | null;
|
|
3131
|
+
workerId: string | null;
|
|
3132
|
+
podStartedAtMs: number | null;
|
|
3133
|
+
workerObservedAt: string | null;
|
|
3134
|
+
};
|
|
3135
|
+
} | undefined;
|
|
3136
|
+
}[];
|
|
3137
|
+
nextCursor: string | null;
|
|
3138
|
+
from: string;
|
|
3139
|
+
to: string;
|
|
3140
|
+
};
|
|
3141
|
+
|
|
3142
|
+
declare const recordingModeSchema: z.ZodEnum<{
|
|
3143
|
+
off: "off";
|
|
3144
|
+
audio: "audio";
|
|
3145
|
+
video: "video";
|
|
3146
|
+
audio_video: "audio_video";
|
|
3147
|
+
participants: "participants";
|
|
3148
|
+
tracks: "tracks";
|
|
3149
|
+
}>;
|
|
3150
|
+
type RecordingMode = z.infer<typeof recordingModeSchema>;
|
|
3151
|
+
declare const recordingArtifactStatusSchema: z.ZodEnum<{
|
|
3152
|
+
ready: "ready";
|
|
3153
|
+
pending: "pending";
|
|
3154
|
+
recording: "recording";
|
|
3155
|
+
processing: "processing";
|
|
3156
|
+
expired: "expired";
|
|
3157
|
+
failed: "failed";
|
|
3158
|
+
}>;
|
|
3159
|
+
type RecordingArtifactStatus = z.infer<typeof recordingArtifactStatusSchema>;
|
|
3160
|
+
declare const recordingArtifactSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
3161
|
+
sessionId: z.ZodString;
|
|
3162
|
+
recordingId: z.ZodString;
|
|
3163
|
+
mode: z.ZodEnum<{
|
|
3164
|
+
audio: "audio";
|
|
3165
|
+
video: "video";
|
|
3166
|
+
audio_video: "audio_video";
|
|
3167
|
+
}>;
|
|
3168
|
+
createdAt: z.ZodString;
|
|
3169
|
+
retainedUntil: z.ZodString;
|
|
3170
|
+
participant: z.ZodOptional<z.ZodObject<{
|
|
3171
|
+
participantIdentity: z.ZodString;
|
|
3172
|
+
role: z.ZodEnum<{
|
|
3173
|
+
avatar: "avatar";
|
|
3174
|
+
user: "user";
|
|
3175
|
+
}>;
|
|
3176
|
+
}, z.core.$strict>>;
|
|
3177
|
+
mediaStartedAt: z.ZodOptional<z.ZodString>;
|
|
3178
|
+
mediaEndedAt: z.ZodOptional<z.ZodString>;
|
|
3179
|
+
mediaStartOffsetMs: z.ZodOptional<z.ZodNumber>;
|
|
3180
|
+
mediaMutedIntervalsMs: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
3181
|
+
startMs: z.ZodNumber;
|
|
3182
|
+
endMs: z.ZodNumber;
|
|
3183
|
+
}, z.core.$strict>>>;
|
|
3184
|
+
status: z.ZodEnum<{
|
|
3185
|
+
pending: "pending";
|
|
3186
|
+
recording: "recording";
|
|
3187
|
+
processing: "processing";
|
|
3188
|
+
expired: "expired";
|
|
3189
|
+
}>;
|
|
3190
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
3191
|
+
sessionId: z.ZodString;
|
|
3192
|
+
recordingId: z.ZodString;
|
|
3193
|
+
mode: z.ZodEnum<{
|
|
3194
|
+
audio: "audio";
|
|
3195
|
+
video: "video";
|
|
3196
|
+
audio_video: "audio_video";
|
|
3197
|
+
}>;
|
|
3198
|
+
createdAt: z.ZodString;
|
|
3199
|
+
retainedUntil: z.ZodString;
|
|
3200
|
+
participant: z.ZodOptional<z.ZodObject<{
|
|
3201
|
+
participantIdentity: z.ZodString;
|
|
3202
|
+
role: z.ZodEnum<{
|
|
3203
|
+
avatar: "avatar";
|
|
3204
|
+
user: "user";
|
|
3205
|
+
}>;
|
|
3206
|
+
}, z.core.$strict>>;
|
|
3207
|
+
mediaStartedAt: z.ZodOptional<z.ZodString>;
|
|
3208
|
+
mediaEndedAt: z.ZodOptional<z.ZodString>;
|
|
3209
|
+
mediaStartOffsetMs: z.ZodOptional<z.ZodNumber>;
|
|
3210
|
+
mediaMutedIntervalsMs: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
3211
|
+
startMs: z.ZodNumber;
|
|
3212
|
+
endMs: z.ZodNumber;
|
|
3213
|
+
}, z.core.$strict>>>;
|
|
3214
|
+
status: z.ZodLiteral<"ready">;
|
|
3215
|
+
mediaType: z.ZodEnum<{
|
|
3216
|
+
"audio/mp4": "audio/mp4";
|
|
3217
|
+
"video/mp4": "video/mp4";
|
|
3218
|
+
"audio/ogg": "audio/ogg";
|
|
3219
|
+
"video/webm": "video/webm";
|
|
3220
|
+
}>;
|
|
3221
|
+
sizeBytes: z.ZodNumber;
|
|
3222
|
+
durationMs: z.ZodNullable<z.ZodNumber>;
|
|
3223
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
3224
|
+
sessionId: z.ZodString;
|
|
3225
|
+
recordingId: z.ZodString;
|
|
3226
|
+
mode: z.ZodEnum<{
|
|
3227
|
+
audio: "audio";
|
|
3228
|
+
video: "video";
|
|
3229
|
+
audio_video: "audio_video";
|
|
3230
|
+
}>;
|
|
3231
|
+
createdAt: z.ZodString;
|
|
3232
|
+
retainedUntil: z.ZodString;
|
|
3233
|
+
participant: z.ZodOptional<z.ZodObject<{
|
|
3234
|
+
participantIdentity: z.ZodString;
|
|
3235
|
+
role: z.ZodEnum<{
|
|
3236
|
+
avatar: "avatar";
|
|
3237
|
+
user: "user";
|
|
3238
|
+
}>;
|
|
3239
|
+
}, z.core.$strict>>;
|
|
3240
|
+
mediaStartedAt: z.ZodOptional<z.ZodString>;
|
|
3241
|
+
mediaEndedAt: z.ZodOptional<z.ZodString>;
|
|
3242
|
+
mediaStartOffsetMs: z.ZodOptional<z.ZodNumber>;
|
|
3243
|
+
mediaMutedIntervalsMs: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
3244
|
+
startMs: z.ZodNumber;
|
|
3245
|
+
endMs: z.ZodNumber;
|
|
3246
|
+
}, z.core.$strict>>>;
|
|
3247
|
+
status: z.ZodLiteral<"failed">;
|
|
3248
|
+
errorCode: z.ZodEnum<{
|
|
3249
|
+
recording_failed: "recording_failed";
|
|
3250
|
+
recording_unavailable: "recording_unavailable";
|
|
3251
|
+
}>;
|
|
3252
|
+
}, z.core.$strict>], "status">;
|
|
3253
|
+
type RecordingArtifact = z.infer<typeof recordingArtifactSchema>;
|
|
3254
|
+
declare const listRecordingsQuerySchema: z.ZodObject<{
|
|
3255
|
+
sessionId: z.ZodOptional<z.ZodString>;
|
|
3256
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
3257
|
+
cursor: z.ZodOptional<z.ZodString>;
|
|
3258
|
+
}, z.core.$strict>;
|
|
3259
|
+
type ListRecordingsQuery = Partial<z.infer<typeof listRecordingsQuerySchema>>;
|
|
3260
|
+
declare const listRecordingsResponseSchema: z.ZodObject<{
|
|
3261
|
+
data: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
3262
|
+
sessionId: z.ZodString;
|
|
3263
|
+
recordingId: z.ZodString;
|
|
3264
|
+
mode: z.ZodEnum<{
|
|
3265
|
+
audio: "audio";
|
|
3266
|
+
video: "video";
|
|
3267
|
+
audio_video: "audio_video";
|
|
3268
|
+
}>;
|
|
3269
|
+
createdAt: z.ZodString;
|
|
3270
|
+
retainedUntil: z.ZodString;
|
|
3271
|
+
participant: z.ZodOptional<z.ZodObject<{
|
|
3272
|
+
participantIdentity: z.ZodString;
|
|
3273
|
+
role: z.ZodEnum<{
|
|
3274
|
+
avatar: "avatar";
|
|
3275
|
+
user: "user";
|
|
3276
|
+
}>;
|
|
3277
|
+
}, z.core.$strict>>;
|
|
3278
|
+
mediaStartedAt: z.ZodOptional<z.ZodString>;
|
|
3279
|
+
mediaEndedAt: z.ZodOptional<z.ZodString>;
|
|
3280
|
+
mediaStartOffsetMs: z.ZodOptional<z.ZodNumber>;
|
|
3281
|
+
mediaMutedIntervalsMs: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
3282
|
+
startMs: z.ZodNumber;
|
|
3283
|
+
endMs: z.ZodNumber;
|
|
3284
|
+
}, z.core.$strict>>>;
|
|
3285
|
+
status: z.ZodEnum<{
|
|
3286
|
+
pending: "pending";
|
|
3287
|
+
recording: "recording";
|
|
3288
|
+
processing: "processing";
|
|
3289
|
+
expired: "expired";
|
|
3290
|
+
}>;
|
|
3291
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
3292
|
+
sessionId: z.ZodString;
|
|
3293
|
+
recordingId: z.ZodString;
|
|
3294
|
+
mode: z.ZodEnum<{
|
|
3295
|
+
audio: "audio";
|
|
3296
|
+
video: "video";
|
|
3297
|
+
audio_video: "audio_video";
|
|
3298
|
+
}>;
|
|
3299
|
+
createdAt: z.ZodString;
|
|
3300
|
+
retainedUntil: z.ZodString;
|
|
3301
|
+
participant: z.ZodOptional<z.ZodObject<{
|
|
3302
|
+
participantIdentity: z.ZodString;
|
|
3303
|
+
role: z.ZodEnum<{
|
|
3304
|
+
avatar: "avatar";
|
|
3305
|
+
user: "user";
|
|
3306
|
+
}>;
|
|
3307
|
+
}, z.core.$strict>>;
|
|
3308
|
+
mediaStartedAt: z.ZodOptional<z.ZodString>;
|
|
3309
|
+
mediaEndedAt: z.ZodOptional<z.ZodString>;
|
|
3310
|
+
mediaStartOffsetMs: z.ZodOptional<z.ZodNumber>;
|
|
3311
|
+
mediaMutedIntervalsMs: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
3312
|
+
startMs: z.ZodNumber;
|
|
3313
|
+
endMs: z.ZodNumber;
|
|
3314
|
+
}, z.core.$strict>>>;
|
|
3315
|
+
status: z.ZodLiteral<"ready">;
|
|
3316
|
+
mediaType: z.ZodEnum<{
|
|
3317
|
+
"audio/mp4": "audio/mp4";
|
|
3318
|
+
"video/mp4": "video/mp4";
|
|
3319
|
+
"audio/ogg": "audio/ogg";
|
|
3320
|
+
"video/webm": "video/webm";
|
|
3321
|
+
}>;
|
|
3322
|
+
sizeBytes: z.ZodNumber;
|
|
3323
|
+
durationMs: z.ZodNullable<z.ZodNumber>;
|
|
3324
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
3325
|
+
sessionId: z.ZodString;
|
|
3326
|
+
recordingId: z.ZodString;
|
|
3327
|
+
mode: z.ZodEnum<{
|
|
3328
|
+
audio: "audio";
|
|
3329
|
+
video: "video";
|
|
3330
|
+
audio_video: "audio_video";
|
|
3331
|
+
}>;
|
|
3332
|
+
createdAt: z.ZodString;
|
|
3333
|
+
retainedUntil: z.ZodString;
|
|
3334
|
+
participant: z.ZodOptional<z.ZodObject<{
|
|
3335
|
+
participantIdentity: z.ZodString;
|
|
3336
|
+
role: z.ZodEnum<{
|
|
3337
|
+
avatar: "avatar";
|
|
3338
|
+
user: "user";
|
|
3339
|
+
}>;
|
|
3340
|
+
}, z.core.$strict>>;
|
|
3341
|
+
mediaStartedAt: z.ZodOptional<z.ZodString>;
|
|
3342
|
+
mediaEndedAt: z.ZodOptional<z.ZodString>;
|
|
3343
|
+
mediaStartOffsetMs: z.ZodOptional<z.ZodNumber>;
|
|
3344
|
+
mediaMutedIntervalsMs: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
3345
|
+
startMs: z.ZodNumber;
|
|
3346
|
+
endMs: z.ZodNumber;
|
|
3347
|
+
}, z.core.$strict>>>;
|
|
3348
|
+
status: z.ZodLiteral<"failed">;
|
|
3349
|
+
errorCode: z.ZodEnum<{
|
|
3350
|
+
recording_failed: "recording_failed";
|
|
3351
|
+
recording_unavailable: "recording_unavailable";
|
|
3352
|
+
}>;
|
|
3353
|
+
}, z.core.$strict>], "status">>;
|
|
3354
|
+
nextCursor: z.ZodNullable<z.ZodString>;
|
|
3355
|
+
}, z.core.$strict>;
|
|
3356
|
+
type ListRecordingsResponse = z.infer<typeof listRecordingsResponseSchema>;
|
|
3357
|
+
declare const recordingAccessResponseSchema: z.ZodObject<{
|
|
3358
|
+
recordingId: z.ZodString;
|
|
1621
3359
|
url: z.ZodString;
|
|
1622
3360
|
expiresAt: z.ZodString;
|
|
1623
3361
|
}, z.core.$strict>;
|
|
1624
3362
|
type RecordingAccessResponse = z.infer<typeof recordingAccessResponseSchema>;
|
|
1625
3363
|
|
|
3364
|
+
type Wire$1 = components["schemas"];
|
|
3365
|
+
declare const voiceWebhookOptionsSchema: z.ZodObject<{
|
|
3366
|
+
url: z.ZodURL;
|
|
3367
|
+
secret: z.ZodString;
|
|
3368
|
+
voiceId: z.ZodOptional<z.ZodString>;
|
|
3369
|
+
language: z.ZodOptional<z.ZodString>;
|
|
3370
|
+
sampleRate: z.ZodOptional<z.ZodLiteral<8000 | 16000 | 22050 | 24000 | 44100 | 48000>>;
|
|
3371
|
+
timeoutMs: z.ZodOptional<z.ZodInt>;
|
|
3372
|
+
}, z.core.$strict>;
|
|
3373
|
+
declare function voiceWebhookToWire(input: z.input<typeof voiceWebhookOptionsSchema>): NonNullable<Wire$1["LiveKitSessionRequest"]["voice_webhook"]>;
|
|
3374
|
+
|
|
1626
3375
|
/**
|
|
1627
3376
|
* The public shapes. Everything an integrator touches is here, in one file, on purpose:
|
|
1628
3377
|
* an agent reading this repo should be able to learn the whole surface without following
|
|
@@ -1642,11 +3391,8 @@ type RecordingAccessResponse = z.infer<typeof recordingAccessResponseSchema>;
|
|
|
1642
3391
|
* `npm run spec:check` reports drift between the vendored copy and the live one, and exits 0
|
|
1643
3392
|
* offline so a fork or an air-gapped runner does not go red for it.
|
|
1644
3393
|
*
|
|
1645
|
-
*
|
|
3394
|
+
* TWO types here are NOT derived, and each has a reason rather than an oversight:
|
|
1646
3395
|
*
|
|
1647
|
-
* ListSessionsOptions the contract declares NO query parameters on GET /v1/usage/sessions.
|
|
1648
|
-
* The route reads them; the spec does not describe them. Fixing that
|
|
1649
|
-
* belongs upstream in the spec export, not here.
|
|
1650
3396
|
* TranscriptPayload the transcript webhook body is not in the published contract at all.
|
|
1651
3397
|
* Same upstream gap, bigger: nothing describes this shape publicly.
|
|
1652
3398
|
* VideoPolicy/VideoEdits curate renderer and look-editing options. Clip behavior is declared
|
|
@@ -1785,6 +3531,24 @@ interface ExternalLlm {
|
|
|
1785
3531
|
/** Sent as `model`. Omit it to let your endpoint choose. */
|
|
1786
3532
|
model?: NonNullable<WireLlm["model"]>;
|
|
1787
3533
|
}
|
|
3534
|
+
/**
|
|
3535
|
+
* Speak this call with your own voice. Each sentence she is about to say is POSTed to `url`,
|
|
3536
|
+
* signed with `secret` (verify it with `verifyVoiceWebhook`), and the audio you stream back is what
|
|
3537
|
+
* she says, lip-synced in both modes.
|
|
3538
|
+
*
|
|
3539
|
+
* `url` must be https and resolve to a public address; redirects are never followed. `secret` is
|
|
3540
|
+
* 16–200 characters and never reaches room or participant metadata. `voiceId` and `language` are
|
|
3541
|
+
* echoed in every request. `sampleRate` (default 24000) is the rate of raw `audio/pcm` replies.
|
|
3542
|
+
* `timeoutMs` (1000–15000, default 5000) bounds the first audio byte of each attempt and every
|
|
3543
|
+
* later gap between chunks.
|
|
3544
|
+
*
|
|
3545
|
+
* It replaces the built-in voice: a mint carrying `voice` as well is refused with 422.
|
|
3546
|
+
*/
|
|
3547
|
+
type VoiceWebhook = Parameters<typeof voiceWebhookToWire>[0];
|
|
3548
|
+
/** The signed `voice.synthesize` request your `VoiceWebhook.url` receives, as `verifyVoiceWebhook` returns it. */
|
|
3549
|
+
type VoiceWebhookRequest = Wire["VoiceWebhookRequest"];
|
|
3550
|
+
/** Why your voice webhook failed: the `code` of an in-call voice error. */
|
|
3551
|
+
type VoiceWebhookErrorCode = Wire["VoiceWebhookErrorCode"];
|
|
1788
3552
|
/** What YOUR SERVER decides about a call. Never accept any of this from a browser. */
|
|
1789
3553
|
interface CallPolicy {
|
|
1790
3554
|
/** Optional server-owned content safety policy. Never accept a selection or disable from the browser. */
|
|
@@ -1812,6 +3576,11 @@ interface CallPolicy {
|
|
|
1812
3576
|
video?: VideoPolicy;
|
|
1813
3577
|
/** Voice override for this call; omit to use the avatar's default. */
|
|
1814
3578
|
voice?: unknown;
|
|
3579
|
+
/**
|
|
3580
|
+
* Speak with your own voice: your endpoint answers each sentence with audio. Carries a secret,
|
|
3581
|
+
* so like `llm` the browser entries of this package cannot send it. See {@link VoiceWebhook}.
|
|
3582
|
+
*/
|
|
3583
|
+
voiceWebhook?: VoiceWebhook;
|
|
1815
3584
|
/**
|
|
1816
3585
|
* Let the browser register tools the model may call.
|
|
1817
3586
|
*
|
|
@@ -1961,41 +3730,25 @@ type AvatarUpdate = Pick<Wire["UpdateAvatarRequest"], "displayName" | "defaultVo
|
|
|
1961
3730
|
* take is sometimes mid-blink. It is the only field that may accompany a source swap.
|
|
1962
3731
|
*/
|
|
1963
3732
|
type AvatarSourceSwap = Required<Pick<Wire["UpdateAvatarRequest"], "sourceAssetId">> & Pick<Wire["UpdateAvatarRequest"], "anchorTimeMs">;
|
|
1964
|
-
type UsageSessionsResponse = Wire["ListUsageSessionsResponse"];
|
|
1965
3733
|
/**
|
|
1966
3734
|
* One billable session — when it ran, how long it was billable for, what it cost.
|
|
1967
3735
|
*
|
|
1968
3736
|
* `activeSeconds` is billable wall time in SECONDS and is null until the session settles;
|
|
1969
|
-
* `metadata` is whatever you passed to `startCall`, `{}` if you passed nothing.
|
|
1970
|
-
*
|
|
1971
|
-
*
|
|
3737
|
+
* `metadata` is whatever you passed to `startCall`, `{}` if you passed nothing.
|
|
3738
|
+
* DERIVATION: the generated runtime page preserves finite propertyNames records that
|
|
3739
|
+
* openapi-typescript currently widens to string index signatures.
|
|
1972
3740
|
*/
|
|
1973
|
-
type UsageSession =
|
|
1974
|
-
|
|
1975
|
-
|
|
1976
|
-
sessions: UsageSession[];
|
|
1977
|
-
/** Pass as `cursor` for the next page. Null on the last one. */
|
|
1978
|
-
nextCursor: UsageSessionsResponse["nextCursor"];
|
|
1979
|
-
/** The window actually served — the platform clamps wide or inverted ranges. */
|
|
1980
|
-
from: UsageSessionsResponse["from"];
|
|
1981
|
-
to: UsageSessionsResponse["to"];
|
|
1982
|
-
}
|
|
3741
|
+
type UsageSession = UsageSessionPage["sessions"][number];
|
|
3742
|
+
/** The validated wire page with `data` renamed to `sessions`; pagination is unchanged. */
|
|
3743
|
+
type UsageSessionPage = ReturnType<typeof toSessionsPage>;
|
|
1983
3744
|
/**
|
|
1984
|
-
*
|
|
1985
|
-
*
|
|
1986
|
-
*
|
|
1987
|
-
* and the fix belongs upstream in the spec export, not here.
|
|
3745
|
+
* Session window, tenant-owned user filter and pagination from the canonical query contract.
|
|
3746
|
+
* DERIVATION: speechDiagnostics is a product boolean for the canonical header's opt-in ability,
|
|
3747
|
+
* not a query parameter. Only true sends that header; false and omission leave it absent.
|
|
1988
3748
|
*/
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
|
-
|
|
1992
|
-
to?: string;
|
|
1993
|
-
/** Only sessions you tagged with this `metadata.user_id`. */
|
|
1994
|
-
endUserId?: string;
|
|
1995
|
-
/** Page size, capped at 200. */
|
|
1996
|
-
limit?: number;
|
|
1997
|
-
cursor?: string;
|
|
1998
|
-
}
|
|
3749
|
+
type ListSessionsOptions = NonNullable<operations["listUsageSessions"]["parameters"]["query"]> & {
|
|
3750
|
+
speechDiagnostics?: NonNullable<operations["listUsageSessions"]["parameters"]["header"]>["X-RTA-Speech-Diagnostics"] extends "1" | undefined ? boolean : never;
|
|
3751
|
+
};
|
|
1999
3752
|
type CreditBalance = Pick<Wire["CreditBalance"], "balanceCreditMicros" | "reservedCreditMicros">;
|
|
2000
3753
|
/**
|
|
2001
3754
|
* Complete desired sources and behavior; expectedRevision protects concurrent edits.
|
|
@@ -2081,4 +3834,4 @@ interface TranscriptPayload {
|
|
|
2081
3834
|
client_metadata: Record<string, string>;
|
|
2082
3835
|
}
|
|
2083
3836
|
|
|
2084
|
-
export { type Avatar as A,
|
|
3837
|
+
export { type Avatar as A, type VoiceWebhook as B, type CallMode as C, type VoiceWebhookErrorCode as D, type EndCallOptions as E, isQueued as F, listRecordingsResponseSchema as G, recordingAccessResponseSchema as H, recordingArtifactSchema as I, recordingModeSchema as J, type LoopRedirect as L, type RecordingArtifact as R, type StartCallResult as S, type TranscriptPayload as T, type UsageSessionPage as U, type VoiceWebhookRequest as V, type CallPolicy as a, type AvatarUpdate as b, type AvatarSourceSwap as c, type ClipLibraryDeclaration as d, type ClipLibraryUpdate as e, type ClipLibrary as f, type AssetKind as g, type Asset as h, type ListSessionsOptions as i, type UsageSession as j, type ListRecordingsQuery as k, type ListRecordingsResponse as l, type RecordingAccessResponse as m, type CreditBalance as n, type AvatarClip as o, type CallConnection as p, type CallQueued as q, type ClipDeclaration as r, type ClipLibraryPlan as s, type ClipSource as t, type ContextMessage as u, type EndCallReason as v, type ExternalLlm as w, type RecordingArtifactStatus as x, type RecordingMode as y, type VideoPolicy as z };
|