@deepraxis/cli 0.3.0-dev.9bfcf33 → 0.3.0-dev.b478c75
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/COMMANDS.md +15 -9
- package/dist/praxis.js +426 -25
- package/package.json +1 -1
package/COMMANDS.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Generated by `bun run commands`. DO NOT EDIT.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
682 HTTP operations; 684 commands including aliases.
|
|
6
6
|
|
|
7
7
|
Environment: `PRAXIS_ENV=develop|production` (dev package defaults to `develop`; stable package defaults to `production`). No `--env` option.
|
|
8
8
|
|
|
@@ -450,6 +450,11 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
450
450
|
| `praxis api media library understanding get-failure-summary` | `media.libraries.understandings.retrieveFailureSummary` | GET `/media/v1/libraries/{library_id}/understandings/failure_summary` | `--library` |
|
|
451
451
|
| `praxis api media library understanding list` | `media.libraries.understandings.list` | GET `/media/v1/libraries/{library_id}/understandings` | `--library`, `--folder`, `--kinds`, `--param-cursor`, `--param-limit` |
|
|
452
452
|
| `praxis api media library update <library_id>` | `media.libraries.update` | PATCH `/media/v1/libraries/{library_id}` | `--hotwords`, `--name` |
|
|
453
|
+
| `praxis api media library voice create` | `media.libraries.voices.create` | POST `/media/v1/libraries/{library_id}/voices` | `--library`, `--name`, `--samples`, `--consent-id`, `--language`, `--description`, `--asset-folder`, `--idempotency-key` |
|
|
454
|
+
| `praxis api media library voice delete <voice_id>` | `media.libraries.voices.delete` | DELETE `/media/v1/libraries/{library_id}/voices/{voice_id}` | `--library` |
|
|
455
|
+
| `praxis api media library voice get <voice_id>` | `media.libraries.voices.retrieve` | GET `/media/v1/libraries/{library_id}/voices/{voice_id}` | `--library` |
|
|
456
|
+
| `praxis api media library voice list` | `media.libraries.voices.list` | GET `/media/v1/libraries/{library_id}/voices` | `--library`, `--param-cursor`, `--param-limit` |
|
|
457
|
+
| `praxis api media library voice-consent create` | `media.libraries.voiceConsents.create` | POST `/media/v1/libraries/{library_id}/voice_consents` | `--library`, `--file-id`, `--speaker-name`, `--language` |
|
|
453
458
|
| `praxis api media speech create` | `media.speech.create` | POST `/media/v1/libraries/{library_id}/audio/speech` | `--library`, `--input`, `--voice`, `--instructions`, `--speed`, `--response-format`, `--language` |
|
|
454
459
|
| `praxis api media video generate` | `media.videos.generate` | POST `/media/v1/libraries/{library_id}/videos/generations` | `--library`, `--prompt`, `--negative-prompt`, `--mode`, `--first-frame`, `--last-frame`, `--duration-seconds`, `--resolution`, `--aspect-ratio`, `--generate-audio`, `--output`, `--n`, `--seed`, `--model`, `--asset-folder`, `--understanding`, `--idempotency-key` |
|
|
455
460
|
| `praxis api meta doc get <path>` | `meta.docs.retrieve` | GET `/meta/v1/docs/{path}` | `--lang` |
|
|
@@ -519,10 +524,11 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
519
524
|
| `praxis api organization feedback message list` | `organization.feedback.messages.list` | GET `/organization/v1/feedback/{id}/messages` | `--feedback`, `--param-limit`, `--page` |
|
|
520
525
|
| `praxis api organization member list` | `organization.members.list` | GET `/organization/v1/members` | `--param-limit`, `--page` |
|
|
521
526
|
| `praxis api organization usage list` | `organization.usage.list` | GET `/organization/v1/usage` | `--starting-at`, `--ending-at`, `--bucket-width`, `--time-zone`, `--group-by`, `--page` |
|
|
522
|
-
| `praxis api sandbox command run <sandbox_id>` | `sandbox.sandboxes.commands.run` | POST `/sandbox/v1/sandboxes/{sandbox_id}/commands` | `--cmd`, `--background`, `--cwd`, `--timeout-ms` |
|
|
527
|
+
| `praxis api sandbox command run <sandbox_id>` | `sandbox.sandboxes.commands.run` | POST `/sandbox/v1/sandboxes/{sandbox_id}/commands` | `--cmd`, `--background`, `--cwd`, `--timeout-ms`, `--progress-timeout-ms` |
|
|
523
528
|
| `praxis api sandbox connect <sandboxID>` | `sandbox.sandboxes.connect` | POST `/sandbox/v1/sandboxes/{sandboxID}/connect` | `--timeout`, `--memory` |
|
|
524
529
|
| `praxis api sandbox create` | `sandbox.sandboxes.create` | POST `/sandbox/v1/sandboxes` | `--template-id`, `--timeout`, `--auto-pause`, `--auto-pause-memory`, `--allow-internet-access` |
|
|
525
530
|
| `praxis api sandbox delete <sandboxID>` | `sandbox.sandboxes.delete` | DELETE `/sandbox/v1/sandboxes/{sandboxID}` | |
|
|
531
|
+
| `praxis api sandbox event sandbox get <sandboxID>` | `sandbox.events.sandboxes.retrieve` | GET `/sandbox/v1/events/sandboxes/{sandboxID}` | `--offset`, `--param-limit`, `--order-asc`, `--types` |
|
|
526
532
|
| `praxis api sandbox extend <sandboxID>` | `sandbox.sandboxes.extend` | POST `/sandbox/v1/sandboxes/{sandboxID}/extend` | `--timeout` |
|
|
527
533
|
| `praxis api sandbox file list` | `sandbox.sandboxes.files.list` | GET `/sandbox/v1/sandboxes/{sandbox_id}/files:list` | `--sandbox`, `--path` |
|
|
528
534
|
| `praxis api sandbox file make-dir <sandbox_id>` | `sandbox.sandboxes.files.makeDir` | POST `/sandbox/v1/sandboxes/{sandbox_id}/files:makeDir` | `--path` |
|
|
@@ -564,13 +570,13 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
564
570
|
| `praxis api search map` | `search.map.create` | POST `/search/v1/map` | `--url`, `--instructions`, `--max-depth`, `--max-breadth`, `--param-limit`, `--select-paths`, `--select-domains`, `--exclude-paths`, `--exclude-domains`, `--allow-external`, `--timeout`, `--include-usage` |
|
|
565
571
|
| `praxis api studio codex create` | `studio.codexes.create` | POST `/studio/v1/codexes` | `--name`, `--description` |
|
|
566
572
|
| `praxis api studio codex delete <codex>` | `studio.codexes.delete` | DELETE `/studio/v1/codexes/{codex}` | |
|
|
567
|
-
| `praxis api studio codex entry create` | `studio.codexes.entries.create` | POST `/studio/v1/codexes/{codex}/entries` | `--codex`, `--type`, `--name`, `--group`, `--aliases`, `--case-sensitive`, `--exclude-phrases`, `--description`, `--notes`, `--
|
|
573
|
+
| `praxis api studio codex entry create` | `studio.codexes.entries.create` | POST `/studio/v1/codexes/{codex}/entries` | `--codex`, `--type`, `--name`, `--group`, `--aliases`, `--case-sensitive`, `--exclude-phrases`, `--description`, `--notes`, `--time`, `--tracking` |
|
|
568
574
|
| `praxis api studio codex entry delete <entry>` | `studio.codexes.entries.delete` | DELETE `/studio/v1/codexes/{codex}/entries/{entry}` | `--codex` |
|
|
569
575
|
| `praxis api studio codex entry get <entry>` | `studio.codexes.entries.retrieve` | GET `/studio/v1/codexes/{codex}/entries/{entry}` | `--codex` |
|
|
570
576
|
| `praxis api studio codex entry list` | `studio.codexes.entries.list` | GET `/studio/v1/codexes/{codex}/entries` | `--codex`, `--page-size`, `--page-token` |
|
|
571
|
-
| `praxis api studio codex entry update <entry>` | `studio.codexes.entries.update` | PATCH `/studio/v1/codexes/{codex}/entries/{entry}` | `--codex`, `--update-mask`, `--type`, `--name`, `--group`, `--aliases`, `--case-sensitive`, `--exclude-phrases`, `--description`, `--notes`, `--
|
|
577
|
+
| `praxis api studio codex entry update <entry>` | `studio.codexes.entries.update` | PATCH `/studio/v1/codexes/{codex}/entries/{entry}` | `--codex`, `--update-mask`, `--type`, `--name`, `--group`, `--aliases`, `--case-sensitive`, `--exclude-phrases`, `--description`, `--notes`, `--time`, `--tracking` |
|
|
572
578
|
| `praxis api studio codex get <codex>` | `studio.codexes.retrieve` | GET `/studio/v1/codexes/{codex}` | |
|
|
573
|
-
| `praxis api studio codex list` | `studio.codexes.list` | GET `/studio/v1/codexes` | `--page-size`, `--page-token` |
|
|
579
|
+
| `praxis api studio codex list` | `studio.codexes.list` | GET `/studio/v1/codexes` | `--page-size`, `--page-token`, `--work` |
|
|
574
580
|
| `praxis api studio codex update <codex>` | `studio.codexes.update` | PATCH `/studio/v1/codexes/{codex}` | `--update-mask`, `--name`, `--description` |
|
|
575
581
|
| `praxis api studio genre get <genre>` | `studio.genres.retrieve` | GET `/studio/v1/genres/{genre}` | |
|
|
576
582
|
| `praxis api studio genre list` | `studio.genres.list` | GET `/studio/v1/genres` | `--include-unavailable` |
|
|
@@ -578,10 +584,10 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
578
584
|
| `praxis api studio platform list` | `studio.platforms.list` | GET `/studio/v1/platforms` | `--genre` |
|
|
579
585
|
| `praxis api studio reviewer list` | `studio.reviewers.list` | GET `/studio/v1/reviewers` | `--kind`, `--page-size`, `--page-token` |
|
|
580
586
|
| `praxis api studio reviewer update <agent>` | `studio.reviewers.update` | PATCH `/studio/v1/reviewers/{agent}` | `--active` |
|
|
581
|
-
| `praxis api studio style create` | `studio.styles.create` | POST `/studio/v1/styles` | `--name`, `--description`, `--samples`, `--use`, `--avoid` |
|
|
587
|
+
| `praxis api studio style create` | `studio.styles.create` | POST `/studio/v1/styles` | `--name`, `--description`, `--samples`, `--work`, `--use`, `--avoid` |
|
|
582
588
|
| `praxis api studio style delete <style>` | `studio.styles.delete` | DELETE `/studio/v1/styles/{style}` | |
|
|
583
589
|
| `praxis api studio style get <style>` | `studio.styles.retrieve` | GET `/studio/v1/styles/{style}` | |
|
|
584
|
-
| `praxis api studio style list` | `studio.styles.list` | GET `/studio/v1/styles` | `--page-size`, `--page-token` |
|
|
590
|
+
| `praxis api studio style list` | `studio.styles.list` | GET `/studio/v1/styles` | `--page-size`, `--page-token`, `--work` |
|
|
585
591
|
| `praxis api studio style update <style>` | `studio.styles.update` | PATCH `/studio/v1/styles/{style}` | `--update-mask`, `--name`, `--description`, `--samples`, `--use`, `--avoid` |
|
|
586
592
|
| `praxis api studio template create` | `studio.templates.create` | POST `/studio/v1/templates` | `--genre`, `--name`, `--guide` |
|
|
587
593
|
| `praxis api studio template delete <template>` | `studio.templates.delete` | DELETE `/studio/v1/templates/{template}` | |
|
|
@@ -592,7 +598,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
592
598
|
| `praxis api studio theme get <theme>` | `studio.themes.retrieve` | GET `/studio/v1/themes/{theme}` | |
|
|
593
599
|
| `praxis api studio theme list` | `studio.themes.list` | GET `/studio/v1/themes` | `--platform`, `--page-size`, `--page-token` |
|
|
594
600
|
| `praxis api studio theme update <theme>` | `studio.themes.update` | PATCH `/studio/v1/themes/{theme}` | `--update-mask`, `--name`, `--html`, `--css`, `--reference-docx`, `--header`, `--footer` |
|
|
595
|
-
| `praxis api studio work create` | `studio.works.create` | POST `/studio/v1/works` | `--title`, `--slug`, `--codexes`, `--style`, `--request-id` |
|
|
601
|
+
| `praxis api studio work create` | `studio.works.create` | POST `/studio/v1/works` | `--title`, `--slug`, `--codexes`, `--style`, `--cover`, `--based-on`, `--request-id` |
|
|
596
602
|
| `praxis api studio work draft create` | `studio.works.drafts.create` | POST `/studio/v1/works/{work}/drafts` | `--work`, `--genre`, `--title`, `--mode`, `--template`, `--request-id` |
|
|
597
603
|
| `praxis api studio work draft get <draft>` | `studio.works.drafts.retrieve` | GET `/studio/v1/works/{work}/drafts/{draft}` | `--work`, `--expand` |
|
|
598
604
|
| `praxis api studio work draft get-export <draft>` | `studio.works.drafts.retrieveExport` | GET `/studio/v1/works/{work}/drafts/{draft}/export` | `--work`, `--param-format` |
|
|
@@ -628,7 +634,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
628
634
|
| `praxis api studio work unit get-context <unit>` | `studio.works.units.retrieveContext` | GET `/studio/v1/works/{work}/units/{unit}/context` | `--work`, `--budget-tokens` |
|
|
629
635
|
| `praxis api studio work unit move <unit>` | `studio.works.units.move` | POST `/studio/v1/works/{work}/units/{unit}:move` | `--work`, `--expected-revision`, `--parent`, `--after` |
|
|
630
636
|
| `praxis api studio work unit update <unit>` | `studio.works.units.update` | PATCH `/studio/v1/works/{work}/units/{unit}` | `--work`, `--expected-revision`, `--name`, `--heading`, `--synopsis`, `--points`, `--brief-points`, `--body`, `--synopsis-from-body`, `--status`, `--seconds`, `--confirm-final-edit` |
|
|
631
|
-
| `praxis api studio work update <work>` | `studio.works.update` | PATCH `/studio/v1/works/{work}` | `--update-mask`, `--expected-revision`, `--title`, `--slug`, `--codexes`, `--style`, `--archived` |
|
|
637
|
+
| `praxis api studio work update <work>` | `studio.works.update` | PATCH `/studio/v1/works/{work}` | `--update-mask`, `--expected-revision`, `--title`, `--slug`, `--codexes`, `--style`, `--cover`, `--archived` |
|
|
632
638
|
| `praxis api studio work update-brief <work>` | `studio.works.updateBrief` | PATCH `/studio/v1/works/{work}/brief` | `--expected-revision`, `--text`, `--attachments`, `--remove-points` |
|
|
633
639
|
| `praxis api ticket activity get` | `ticket.activity.retrieve` | GET `/ticket/v1/activity` | `--repository`, `--page-size`, `--page-token`, `--filter` |
|
|
634
640
|
| `praxis api ticket comment create` | `ticket.tickets.comments.create` | POST `/ticket/v1/tickets/{number}/comments` | `--ticket`, `--repository`, `--body`, `--in-reply-to` |
|
package/dist/praxis.js
CHANGED
|
@@ -22535,7 +22535,7 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
22535
22535
|
resource: "media.speech",
|
|
22536
22536
|
method: "create",
|
|
22537
22537
|
summary: "Create speech",
|
|
22538
|
-
description: "Synthesise speech from text and store the recording straight into the library. Use library_id from creation or listing; the path segment {library_id} also accepts the literal default, which resolves to the organization’s default library before the credential check, so an agent that has never listed a library can still synthesise. input is the text to speak and voice is required
|
|
22538
|
+
description: "Synthesise speech from text and store the recording straight into the library. Use library_id from creation or listing; the path segment {library_id} also accepts the literal default, which resolves to the organization’s default library before the credential check, so an agent that has never listed a library can still synthesise. input is the text to speak and voice is required: voice may be a platform voice name, or the id of a voice material of this library (voice_id from voices.create or voices.list), and a first synthesis with such a material clones it on demand if the supplier does not hold it yet — the clone is charged as the clone it is, once. speed is passed to the provider unchanged, and instructions and language are refused with OPERATION_NOT_SUPPORTED in this release. The provider caps one request at a short stretch of text, so a long input is cut into segments at paragraph and sentence boundaries and synthesised in order, then joined into the single recording the library receives: nothing is spoken twice and nothing is dropped. Because the segments are joined byte for byte, a multi-segment input accepts only response_format mp3 (the default) or pcm; opus is available for a single-segment input. A speech job has one result however many segments it took. Synthesis is billed by the model usage it consumes, at the same prices as the model API, and the job records the charge in usage; a request refused before it starts costs nothing. The response is 202 with a queued Job whose type is speech and whose operation is generate; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until its status is completed or failed, then read the produced asset from the library — the recording carries material_type audio, audio_role voice, ai_generated true, and provenance naming this job, the text spoken and the model. Send Idempotency-Key, or idempotency_key in the body, to retry without synthesising and charging twice. Example: POST /media/v1/libraries/default/audio/speech with {\"input\":\"A red kite above a calm sea at sunrise.\",\"voice\":\"alloy\"}.",
|
|
22539
22539
|
http: "POST",
|
|
22540
22540
|
path: "/media/v1/libraries/{library_id}/audio/speech",
|
|
22541
22541
|
streaming: "no",
|
|
@@ -22561,19 +22561,19 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
22561
22561
|
name: "voice",
|
|
22562
22562
|
type: "string",
|
|
22563
22563
|
required: true,
|
|
22564
|
-
description: "Voice
|
|
22564
|
+
description: "Voice to speak with: either a platform voice name, or the id of a voice material of this library (voice_id from voice creation or listing). Naming a voice material speaks with that cloned voice, and the first synthesis after the material is created clones it on demand if the supplier does not hold it yet; a recording that is not a voice material of this library is passed to the provider as a platform voice name, and its own verdict comes back."
|
|
22565
22565
|
},
|
|
22566
22566
|
{
|
|
22567
22567
|
name: "instructions",
|
|
22568
22568
|
type: "string",
|
|
22569
22569
|
required: false,
|
|
22570
|
-
description: "Emotion and style guidance for the synthesized speech."
|
|
22570
|
+
description: "Emotion and style guidance for the synthesized speech; refused as OPERATION_NOT_SUPPORTED because the speech lane has no equivalent field."
|
|
22571
22571
|
},
|
|
22572
22572
|
{
|
|
22573
22573
|
name: "speed",
|
|
22574
22574
|
type: "number",
|
|
22575
22575
|
required: false,
|
|
22576
|
-
description: "Speaking-rate multiplier;
|
|
22576
|
+
description: "Speaking-rate multiplier; the provider’s own span decides, and a value outside it is refused by the provider."
|
|
22577
22577
|
},
|
|
22578
22578
|
{
|
|
22579
22579
|
name: "response_format",
|
|
@@ -22587,13 +22587,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
22587
22587
|
"pcm"
|
|
22588
22588
|
],
|
|
22589
22589
|
required: false,
|
|
22590
|
-
description: "Audio encoding of the synthesized speech."
|
|
22590
|
+
description: "Audio encoding of the synthesized speech; defaults to mp3. A text long enough to need several segments accepts mp3 or pcm only, because those concatenate head to tail."
|
|
22591
22591
|
},
|
|
22592
22592
|
{
|
|
22593
22593
|
name: "language",
|
|
22594
22594
|
type: "string",
|
|
22595
22595
|
required: false,
|
|
22596
|
-
description: "
|
|
22596
|
+
description: "Spoken language; refused as OPERATION_NOT_SUPPORTED because the voice decides it."
|
|
22597
22597
|
}
|
|
22598
22598
|
]
|
|
22599
22599
|
}
|
|
@@ -23480,6 +23480,196 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
23480
23480
|
]
|
|
23481
23481
|
}
|
|
23482
23482
|
},
|
|
23483
|
+
{
|
|
23484
|
+
resource: "media.libraries.voiceConsents",
|
|
23485
|
+
method: "create",
|
|
23486
|
+
summary: "Create voice consent",
|
|
23487
|
+
description: "Record a speaker’s authorisation to clone their voice into this library. Use library_id from creation or listing; the path segment {library_id} also accepts the literal default, which resolves to the organization’s default library before the credential check. Upload the statement the speaker read as a recording first and send its file_id — the recording must be audio the file service can type (mp3, wav, ogg, m4a, aac or pcm), because a consent recorded into a document would look valid here and only fail at the clone; the file must belong to this organization, and a file_id that names nothing here answers FETCH_FAILED. speaker_name and language are required, and language is the BCP-47 tag the statement was read in. A consent is bound to this one library and to this one language, and a voice created from it must name the same language. Making a consent is free and starts no job. The answer is the consent itself; store its id, because a consent is never listed or read back — it is reached through the id the voice records. Example: POST /media/v1/libraries/default/voice_consents with {\"file_id\":\"file-8c2a5f41d0b34e77\",\"speaker_name\":\"李静\",\"language\":\"zh-CN\"}.",
|
|
23488
|
+
http: "POST",
|
|
23489
|
+
path: "/media/v1/libraries/{library_id}/voice_consents",
|
|
23490
|
+
streaming: "no",
|
|
23491
|
+
pagination: false,
|
|
23492
|
+
pathParams: [
|
|
23493
|
+
{
|
|
23494
|
+
name: "library_id",
|
|
23495
|
+
sdkName: "library_id",
|
|
23496
|
+
description: "Library ID returned by creation."
|
|
23497
|
+
}
|
|
23498
|
+
],
|
|
23499
|
+
query: [],
|
|
23500
|
+
body: {
|
|
23501
|
+
required: true,
|
|
23502
|
+
fields: [
|
|
23503
|
+
{
|
|
23504
|
+
name: "file_id",
|
|
23505
|
+
type: "string",
|
|
23506
|
+
required: true,
|
|
23507
|
+
description: "Platform file identifier beginning with file- of the recording the statement was read into. It must be a recording the file service can type (mp3, wav, ogg, m4a, aac or pcm); a document pasted here is refused with INVALID_PARAMS, because a consent that looked valid here would only fail at the clone. The file must belong to this organization."
|
|
23508
|
+
},
|
|
23509
|
+
{
|
|
23510
|
+
name: "speaker_name",
|
|
23511
|
+
type: "string",
|
|
23512
|
+
required: true,
|
|
23513
|
+
description: "Name of the person who gave the authorisation, recorded as written on the statement and shown wherever the consent is cited."
|
|
23514
|
+
},
|
|
23515
|
+
{
|
|
23516
|
+
name: "language",
|
|
23517
|
+
type: "string",
|
|
23518
|
+
required: true,
|
|
23519
|
+
description: "Language tag in BCP-47 form, such as zh-CN or en-US."
|
|
23520
|
+
}
|
|
23521
|
+
]
|
|
23522
|
+
}
|
|
23523
|
+
},
|
|
23524
|
+
{
|
|
23525
|
+
resource: "media.libraries.voices",
|
|
23526
|
+
method: "list",
|
|
23527
|
+
summary: "List voices",
|
|
23528
|
+
description: "List this library’s voice materials, newest first, to show what the library can speak in or to find an id to synthesise with. Use library_id from creation or listing; the path segment {library_id} also accepts the literal default, which resolves to the organization’s default library before the credential check. Continue with next_cursor and keep the same library; limit is 1 through 200 and defaults to 50. A deleted voice stops appearing, and a material whose own record cannot be read is left out rather than failing the whole page. This collection takes no filter today, so a filter argument is refused with INVALID_FILTER rather than ignored. This is a read: it starts no clone and changes no material. Example: GET /media/v1/libraries/default/voices?limit=50.",
|
|
23529
|
+
http: "GET",
|
|
23530
|
+
path: "/media/v1/libraries/{library_id}/voices",
|
|
23531
|
+
streaming: "no",
|
|
23532
|
+
pagination: true,
|
|
23533
|
+
pathParams: [
|
|
23534
|
+
{
|
|
23535
|
+
name: "library_id",
|
|
23536
|
+
sdkName: "library_id",
|
|
23537
|
+
description: "Library ID returned by creation."
|
|
23538
|
+
}
|
|
23539
|
+
],
|
|
23540
|
+
query: [
|
|
23541
|
+
{
|
|
23542
|
+
name: "cursor",
|
|
23543
|
+
type: "string",
|
|
23544
|
+
required: false,
|
|
23545
|
+
description: "Cursor from the previous next_cursor."
|
|
23546
|
+
},
|
|
23547
|
+
{
|
|
23548
|
+
name: "limit",
|
|
23549
|
+
type: "integer",
|
|
23550
|
+
required: false,
|
|
23551
|
+
description: "Maximum voices in this page, from 1 through 200; defaults to 50. Continue with the next_cursor from the previous response and keep the same library."
|
|
23552
|
+
}
|
|
23553
|
+
]
|
|
23554
|
+
},
|
|
23555
|
+
{
|
|
23556
|
+
resource: "media.libraries.voices",
|
|
23557
|
+
method: "create",
|
|
23558
|
+
summary: "Create voice",
|
|
23559
|
+
description: "Clone a voice from recordings of a consenting speaker and keep it as a voice material of this library. Use library_id from creation or listing; the path segment {library_id} also accepts the literal default, which resolves to the organization’s default library before the credential check. A voice is made in two steps: record the speaker’s consent first (voice_consents.create) and send its consent_id here. The consent must belong to this same library and name the same language as the request — a consent recorded elsewhere, a language that differs from the consent’s, or a missing consent_id is refused with CONSENT_REQUIRED, so a voice can never be cloned from an authorisation given in another library. samples lists the recordings to clone from, in order: the first one is cloned and decides the material’s stored audio format, and each must be a recording of a format the clone lane accepts (mp3, wav, ogg, m4a, aac or pcm); a sample that is not audio is refused with INVALID_PARAMS before a job exists and before anything is charged. name and language are required; labels, description and asset_folder are optional. Cloning is billed per successful clone, priced as the doubao-voice-clone-2.0 entry in the model catalogue, and a clone refused before it starts costs nothing. The response is 202 with a queued Job; the voice material is listed and readable from the moment this call answers, so poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until the job is completed or failed, then read providers[].state — training while the supplier is still learning the voice, ready when it can be spoken with, and failed with the job holding the reason. Speak with the material by naming its id as voice at audio/speech. Send Idempotency-Key, or idempotency_key in the body, to retry without cloning and charging twice. Example: POST /media/v1/libraries/default/voices with {\"name\":\"店员小何\",\"samples\":[\"file-8c2a5f41d0b34e77\"],\"consent_id\":\"vcn_3f9a1c47e2b04d68\",\"language\":\"zh-CN\"}.",
|
|
23560
|
+
http: "POST",
|
|
23561
|
+
path: "/media/v1/libraries/{library_id}/voices",
|
|
23562
|
+
streaming: "no",
|
|
23563
|
+
pagination: false,
|
|
23564
|
+
pathParams: [
|
|
23565
|
+
{
|
|
23566
|
+
name: "library_id",
|
|
23567
|
+
sdkName: "library_id",
|
|
23568
|
+
description: "Library ID returned by creation."
|
|
23569
|
+
}
|
|
23570
|
+
],
|
|
23571
|
+
query: [],
|
|
23572
|
+
body: {
|
|
23573
|
+
required: true,
|
|
23574
|
+
fields: [
|
|
23575
|
+
{
|
|
23576
|
+
name: "name",
|
|
23577
|
+
type: "string",
|
|
23578
|
+
required: true,
|
|
23579
|
+
description: "Display name of the voice material, shown wherever a voice is chosen; it may be changed later through the asset update."
|
|
23580
|
+
},
|
|
23581
|
+
{
|
|
23582
|
+
name: "samples",
|
|
23583
|
+
type: "array",
|
|
23584
|
+
itemType: "string",
|
|
23585
|
+
required: true,
|
|
23586
|
+
description: "Recordings the clone is made from, in order. The first is the one cloned and decides the material’s stored audio format; each must be a recording the file service holds for this organization, and a sample that is not audio is refused before a job exists and before anything is charged."
|
|
23587
|
+
},
|
|
23588
|
+
{
|
|
23589
|
+
name: "consent_id",
|
|
23590
|
+
type: "string",
|
|
23591
|
+
required: true,
|
|
23592
|
+
description: "Consent identifier beginning with vcn_, from creating a consent in this same library. A consent authorises one library and one language only: an id recorded elsewhere is answered as CONSENT_REQUIRED rather than as a foreign resource."
|
|
23593
|
+
},
|
|
23594
|
+
{
|
|
23595
|
+
name: "language",
|
|
23596
|
+
type: "string",
|
|
23597
|
+
required: true,
|
|
23598
|
+
description: "Language tag in BCP-47 form, such as zh-CN or en-US."
|
|
23599
|
+
},
|
|
23600
|
+
{
|
|
23601
|
+
name: "labels",
|
|
23602
|
+
type: "object",
|
|
23603
|
+
required: false,
|
|
23604
|
+
description: "Key-value labels for finding the material in a listing, at most 16 keys of at most 128 characters each; they travel onto usage events."
|
|
23605
|
+
},
|
|
23606
|
+
{
|
|
23607
|
+
name: "description",
|
|
23608
|
+
type: "string",
|
|
23609
|
+
required: false,
|
|
23610
|
+
description: "Free-text note about the voice, such as its tone or intended use."
|
|
23611
|
+
},
|
|
23612
|
+
{
|
|
23613
|
+
name: "asset_folder",
|
|
23614
|
+
type: "string",
|
|
23615
|
+
required: false,
|
|
23616
|
+
description: "Folder the voice material is filed under; omitted files it at the library root. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out."
|
|
23617
|
+
},
|
|
23618
|
+
{
|
|
23619
|
+
name: "idempotency_key",
|
|
23620
|
+
type: "string",
|
|
23621
|
+
required: false,
|
|
23622
|
+
description: "Stable key so a retried request reuses the same clone instead of cloning and charging twice; reusing it with different content is rejected."
|
|
23623
|
+
}
|
|
23624
|
+
]
|
|
23625
|
+
}
|
|
23626
|
+
},
|
|
23627
|
+
{
|
|
23628
|
+
resource: "media.libraries.voices",
|
|
23629
|
+
method: "delete",
|
|
23630
|
+
summary: "Delete voice",
|
|
23631
|
+
description: "Delete one voice material from this library. Use library_id from creation or listing and voice_id from voice creation or listing; library_id also accepts the literal default, which resolves to the organization’s default library before the credential check. Deletion makes the material unusable for synthesis and hides it from listing, and it is a tombstone rather than an erasure: an id that names no voice of this library is answered the same way a deleted one is, and there is no restore for a single asset. The recordings the clone was made from are files, not assets, so they are unaffected. The answer confirms the deletion. Example: DELETE /media/v1/libraries/default/voices/9dfa312ef9bc4b00816339b598b1152c.",
|
|
23632
|
+
http: "DELETE",
|
|
23633
|
+
path: "/media/v1/libraries/{library_id}/voices/{voice_id}",
|
|
23634
|
+
streaming: "no",
|
|
23635
|
+
pagination: false,
|
|
23636
|
+
pathParams: [
|
|
23637
|
+
{
|
|
23638
|
+
name: "library_id",
|
|
23639
|
+
sdkName: "library_id",
|
|
23640
|
+
description: "Library ID returned by creation."
|
|
23641
|
+
},
|
|
23642
|
+
{
|
|
23643
|
+
name: "voice_id",
|
|
23644
|
+
sdkName: "voice_id",
|
|
23645
|
+
description: "Voice material identifier returned by voice creation or listing; it is the id of the library asset that carries the voice."
|
|
23646
|
+
}
|
|
23647
|
+
],
|
|
23648
|
+
query: []
|
|
23649
|
+
},
|
|
23650
|
+
{
|
|
23651
|
+
resource: "media.libraries.voices",
|
|
23652
|
+
method: "retrieve",
|
|
23653
|
+
summary: "Get voice",
|
|
23654
|
+
description: "Read one voice material of this library: its name, language, labels, the recordings it was cloned from, the consent that authorises it, and one entry per supplier holding it. Use library_id from creation or listing and voice_id from voice creation or listing; library_id also accepts the literal default, which resolves to the organization’s default library before the credential check. Read providers[].state to know whether the clone finished: ready means synthesis can use it now, training means the supplier is still learning it, and failed means the clone was refused with the reason on the Job that ran it. A voice of another library is not found here — an id that names no voice of this library answers ASSET_NOT_FOUND rather than a hint that it exists elsewhere — and a deleted material answers the same way. This is a read: it starts no clone. Example: GET /media/v1/libraries/default/voices/9dfa312ef9bc4b00816339b598b1152c.",
|
|
23655
|
+
http: "GET",
|
|
23656
|
+
path: "/media/v1/libraries/{library_id}/voices/{voice_id}",
|
|
23657
|
+
streaming: "no",
|
|
23658
|
+
pagination: false,
|
|
23659
|
+
pathParams: [
|
|
23660
|
+
{
|
|
23661
|
+
name: "library_id",
|
|
23662
|
+
sdkName: "library_id",
|
|
23663
|
+
description: "Library ID returned by creation."
|
|
23664
|
+
},
|
|
23665
|
+
{
|
|
23666
|
+
name: "voice_id",
|
|
23667
|
+
sdkName: "voice_id",
|
|
23668
|
+
description: "Voice material identifier returned by voice creation or listing; it is the id of the library asset that carries the voice."
|
|
23669
|
+
}
|
|
23670
|
+
],
|
|
23671
|
+
query: []
|
|
23672
|
+
},
|
|
23483
23673
|
{
|
|
23484
23674
|
resource: "meta.docs",
|
|
23485
23675
|
method: "search",
|
|
@@ -27007,6 +27197,50 @@ for more details.`
|
|
|
27007
27197
|
}
|
|
27008
27198
|
]
|
|
27009
27199
|
},
|
|
27200
|
+
{
|
|
27201
|
+
resource: "sandbox.events.sandboxes",
|
|
27202
|
+
method: "retrieve",
|
|
27203
|
+
summary: "Get sandbox events",
|
|
27204
|
+
description: "Read one sandbox's lifecycle events, newest first by default. Unlike every other read on this face, it answers for a sandbox whose machine has ENDED (killed or failed) — a sandbox's cause of death is readable here even after its files are gone. The killed event carries eventData.terminationReason (the platform's own reason: requested, lease_expired, max_running, provider_lost, start_failed, retention, admin, unknown) and eventData.kill_reason (the E2B-shaped bucket: request, timeout, admin, orphaned, unknown); the updated event carries expiresAt. Page with offset, limit (1–100, default 10), orderAsc and repeatable types. An ended sandbox that is never going to come back also answers SANDBOX_EXPIRED (410) with terminationReason on its files and commands.",
|
|
27205
|
+
http: "GET",
|
|
27206
|
+
path: "/sandbox/v1/events/sandboxes/{sandboxID}",
|
|
27207
|
+
streaming: "no",
|
|
27208
|
+
pagination: false,
|
|
27209
|
+
pathParams: [
|
|
27210
|
+
{
|
|
27211
|
+
name: "sandboxID",
|
|
27212
|
+
sdkName: "sandboxID",
|
|
27213
|
+
description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404."
|
|
27214
|
+
}
|
|
27215
|
+
],
|
|
27216
|
+
query: [
|
|
27217
|
+
{
|
|
27218
|
+
name: "offset",
|
|
27219
|
+
type: "integer",
|
|
27220
|
+
required: false,
|
|
27221
|
+
description: "Number of the newest events to skip before collecting the page; omit to start at the first one. Use it with limit to walk pages: the next page is offset + limit."
|
|
27222
|
+
},
|
|
27223
|
+
{
|
|
27224
|
+
name: "limit",
|
|
27225
|
+
type: "integer",
|
|
27226
|
+
required: false,
|
|
27227
|
+
description: "Page size from 1 to 100; defaults to 10. A larger value returns INVALID_PARAMS rather than being clipped."
|
|
27228
|
+
},
|
|
27229
|
+
{
|
|
27230
|
+
name: "orderAsc",
|
|
27231
|
+
type: "boolean",
|
|
27232
|
+
required: false,
|
|
27233
|
+
description: "true returns the oldest event first, false or omitted returns the newest first. Only the literal spellings true and false are accepted."
|
|
27234
|
+
},
|
|
27235
|
+
{
|
|
27236
|
+
name: "types",
|
|
27237
|
+
type: "array",
|
|
27238
|
+
itemType: "string",
|
|
27239
|
+
required: false,
|
|
27240
|
+
description: "Filter events to the provided event types"
|
|
27241
|
+
}
|
|
27242
|
+
]
|
|
27243
|
+
},
|
|
27010
27244
|
{
|
|
27011
27245
|
resource: "sandbox.sandboxes",
|
|
27012
27246
|
method: "list",
|
|
@@ -27700,6 +27934,12 @@ for more details.`
|
|
|
27700
27934
|
type: "integer",
|
|
27701
27935
|
required: false,
|
|
27702
27936
|
description: "Execution timeout in milliseconds, from 1 to 3600000 (1 hour); defaults to 600000 (10 minutes). In background mode this limits process runtime; expiry records exit code 124."
|
|
27937
|
+
},
|
|
27938
|
+
{
|
|
27939
|
+
name: "progressTimeoutMs",
|
|
27940
|
+
type: "integer",
|
|
27941
|
+
required: false,
|
|
27942
|
+
description: "Foreground commands only, off by default: end this command once it goes this many milliseconds (1000 to 3600000) without writing a single byte to stdout or stderr, and answer COMMAND_NO_PROGRESS (504) with the output received so far and lastOutputAt. The sandbox itself keeps running, so decide afterwards whether to read what it produced or stop it with DELETE. A slow command that keeps producing output is never ended by it; if the program buffers its output, turn buffering off first, for example PYTHONUNBUFFERED=1 or stdbuf -oL. Passing it together with background true is refused with INVALID_PARAMS."
|
|
27703
27943
|
}
|
|
27704
27944
|
]
|
|
27705
27945
|
}
|
|
@@ -29001,7 +29241,7 @@ for more details.`
|
|
|
29001
29241
|
resource: "studio.codexes",
|
|
29002
29242
|
method: "list",
|
|
29003
29243
|
summary: "List the reference libraries of this organization",
|
|
29004
|
-
description: "List the reference libraries this API key organization owns, each with how many entries it holds, so you can choose the one a work draws on. Continue with next_page_token until the answer stops carrying one.
|
|
29244
|
+
description: "List the reference libraries this API key organization owns, each with how many entries it holds, so you can choose the one a work draws on. Continue with next_page_token until the answer stops carrying one. Pass work to read one work's own library alone; leave it out for every library the organization owns.",
|
|
29005
29245
|
http: "GET",
|
|
29006
29246
|
path: "/studio/v1/codexes",
|
|
29007
29247
|
streaming: "no",
|
|
@@ -29019,6 +29259,12 @@ for more details.`
|
|
|
29019
29259
|
type: "string",
|
|
29020
29260
|
required: false,
|
|
29021
29261
|
description: "Cursor from the previous answer's next_page_token; it is opaque, so pass it back unchanged and never build one from an id or an offset."
|
|
29262
|
+
},
|
|
29263
|
+
{
|
|
29264
|
+
name: "work",
|
|
29265
|
+
type: "string",
|
|
29266
|
+
required: false,
|
|
29267
|
+
description: "Narrow the list to what belongs to one work, by its wk_ identifier, which is how one work's own setting is told apart from the organization's shared material; omit it to list everything this organization owns."
|
|
29022
29268
|
}
|
|
29023
29269
|
]
|
|
29024
29270
|
},
|
|
@@ -29026,7 +29272,7 @@ for more details.`
|
|
|
29026
29272
|
resource: "studio.codexes",
|
|
29027
29273
|
method: "create",
|
|
29028
29274
|
summary: "Create a reference library",
|
|
29029
|
-
description: "Create a reference library: a
|
|
29275
|
+
description: "Create a reference library: a store of the people, places, products and facts a piece draws on. Attach it to a work with the work update call, and the entries it holds then reach the context packs of that work's units. A library made this way is shared across works, which suits brand facts several pieces mention; the library a work needs for its own setting is created with the work itself, and the work list call finds it by filtering on work.",
|
|
29030
29276
|
http: "POST",
|
|
29031
29277
|
path: "/studio/v1/codexes",
|
|
29032
29278
|
streaming: "no",
|
|
@@ -29176,7 +29422,7 @@ for more details.`
|
|
|
29176
29422
|
resource: "studio.codexes.entries",
|
|
29177
29423
|
method: "create",
|
|
29178
29424
|
summary: "Add an entry to a reference library",
|
|
29179
|
-
description: "Add one entry: a character, a place, a product, a source of facts. Give it the type the genre uses, the name the text will mention, and the description
|
|
29425
|
+
description: "Add one entry: a character, a place, a product, a source of facts. Give it the type the genre uses, the name the text will mention, and the description, notes, facts and story time that should reach a writer when it is mentioned. Attach a picture gallery when the entry should be looked at as well as read. Aliases and excluded phrases keep detection honest, so a common word inside an idiom is not mistaken for the entry. A name already used in the library is refused.",
|
|
29180
29426
|
http: "POST",
|
|
29181
29427
|
path: "/studio/v1/codexes/{codex}/entries",
|
|
29182
29428
|
streaming: "no",
|
|
@@ -29261,7 +29507,13 @@ for more details.`
|
|
|
29261
29507
|
name: "notes",
|
|
29262
29508
|
type: "string",
|
|
29263
29509
|
required: false,
|
|
29264
|
-
description: "Notes
|
|
29510
|
+
description: "Notes on this entry, which reach the writer's context pack on the line after the description and the facts; an empty string adds no line. Write here what the text must respect, not a private remark."
|
|
29511
|
+
},
|
|
29512
|
+
{
|
|
29513
|
+
name: "time",
|
|
29514
|
+
type: "string",
|
|
29515
|
+
required: false,
|
|
29516
|
+
description: "When this entry happens in the story, such as 2037 or 民国二十四年冬; at most 40 characters, and an empty string records no time. It is shown beside the entry and reaches the writer with it."
|
|
29265
29517
|
},
|
|
29266
29518
|
{
|
|
29267
29519
|
name: "tracking",
|
|
@@ -29284,9 +29536,9 @@ for more details.`
|
|
|
29284
29536
|
{
|
|
29285
29537
|
name: "images",
|
|
29286
29538
|
type: "array",
|
|
29287
|
-
itemType: "
|
|
29539
|
+
itemType: "object",
|
|
29288
29540
|
required: false,
|
|
29289
|
-
description: "
|
|
29541
|
+
description: "Picture gallery of this entry, in write order: send pictures with a name and a description, or send a bare file identifier when the picture has no name yet and it is stored with both empty."
|
|
29290
29542
|
}
|
|
29291
29543
|
]
|
|
29292
29544
|
}
|
|
@@ -29318,7 +29570,7 @@ for more details.`
|
|
|
29318
29570
|
resource: "studio.codexes.entries",
|
|
29319
29571
|
method: "retrieve",
|
|
29320
29572
|
summary: "Read one reference entry",
|
|
29321
|
-
description: "Read one entry in full: its description, its fact ledger, its relations to other entries, its detection settings and its
|
|
29573
|
+
description: "Read one entry in full: its description, its notes, its fact ledger, its relations to other entries, its story time, its detection settings and its picture gallery. Read it before changing it, because an update replaces the fields it names rather than merging them. The entry is addressed by its name in this library, or by its ent_ identifier.",
|
|
29322
29574
|
http: "GET",
|
|
29323
29575
|
path: "/studio/v1/codexes/{codex}/entries/{entry}",
|
|
29324
29576
|
streaming: "no",
|
|
@@ -29341,7 +29593,7 @@ for more details.`
|
|
|
29341
29593
|
resource: "studio.codexes.entries",
|
|
29342
29594
|
method: "update",
|
|
29343
29595
|
summary: "Change what a reference entry says",
|
|
29344
|
-
description: "Change one entry: its type, its name, its aliases, its description, its facts, its notes, its tracking setting, its
|
|
29596
|
+
description: "Change one entry: its type, its name, its aliases, its description, its facts, its notes, its story time, its tracking setting, its picture gallery or its relations. Send update_mask naming exactly the fields you change, because a field the mask leaves out keeps its value while a list field the mask names is replaced whole. Renaming an entry changes what the text has to mention for detection to find it.",
|
|
29345
29597
|
http: "PATCH",
|
|
29346
29598
|
path: "/studio/v1/codexes/{codex}/entries/{entry}",
|
|
29347
29599
|
streaming: "no",
|
|
@@ -29438,7 +29690,13 @@ for more details.`
|
|
|
29438
29690
|
name: "notes",
|
|
29439
29691
|
type: "string",
|
|
29440
29692
|
required: false,
|
|
29441
|
-
description: "New notes
|
|
29693
|
+
description: "New notes on this entry, replacing the previous ones; they reach the writer's context pack on the line after the description and the facts, and an empty string removes that line."
|
|
29694
|
+
},
|
|
29695
|
+
{
|
|
29696
|
+
name: "time",
|
|
29697
|
+
type: "string",
|
|
29698
|
+
required: false,
|
|
29699
|
+
description: "New story time for this entry, replacing the previous one; at most 40 characters, and an empty string removes the time."
|
|
29442
29700
|
},
|
|
29443
29701
|
{
|
|
29444
29702
|
name: "tracking",
|
|
@@ -29461,9 +29719,9 @@ for more details.`
|
|
|
29461
29719
|
{
|
|
29462
29720
|
name: "images",
|
|
29463
29721
|
type: "array",
|
|
29464
|
-
itemType: "
|
|
29722
|
+
itemType: "object",
|
|
29465
29723
|
required: false,
|
|
29466
|
-
description: "Complete
|
|
29724
|
+
description: "Complete picture gallery for this entry, replacing the previous one and keeping the order you send; a picture left out stops being shown beside the entry."
|
|
29467
29725
|
}
|
|
29468
29726
|
]
|
|
29469
29727
|
}
|
|
@@ -29628,6 +29886,12 @@ for more details.`
|
|
|
29628
29886
|
type: "string",
|
|
29629
29887
|
required: false,
|
|
29630
29888
|
description: "Cursor from the previous answer's next_page_token; it is opaque, so pass it back unchanged and never build one from an id or an offset."
|
|
29889
|
+
},
|
|
29890
|
+
{
|
|
29891
|
+
name: "work",
|
|
29892
|
+
type: "string",
|
|
29893
|
+
required: false,
|
|
29894
|
+
description: "Narrow the list to what belongs to one work, by its wk_ identifier, which is how one work's own setting is told apart from the organization's shared material; omit it to list everything this organization owns."
|
|
29631
29895
|
}
|
|
29632
29896
|
]
|
|
29633
29897
|
},
|
|
@@ -29635,7 +29899,7 @@ for more details.`
|
|
|
29635
29899
|
resource: "studio.styles",
|
|
29636
29900
|
method: "create",
|
|
29637
29901
|
summary: "Create a writing style",
|
|
29638
|
-
description: "Create a style: the voice a piece is written in, held as samples rather than as adjectives. Samples matter more than a description, so paste one to five paragraphs of writing the piece should sound like, and put the words to avoid into avoid so the banned-word check uses them. Attach a style to a work, or to one draft of it, and its samples then reach every context pack.",
|
|
29902
|
+
description: "Create a style: the voice a piece is written in, held as samples rather than as adjectives. Samples matter more than a description, so paste one to five paragraphs of writing the piece should sound like, and put the words to avoid into avoid so the banned-word check uses them. A style belongs to the work you name in work, and a work may only attach its own styles, so create the style with the work it will be used in. Attach a style to a work, or to one draft of it, and its samples then reach every context pack.",
|
|
29639
29903
|
http: "POST",
|
|
29640
29904
|
path: "/studio/v1/styles",
|
|
29641
29905
|
streaming: "no",
|
|
@@ -29664,6 +29928,19 @@ for more details.`
|
|
|
29664
29928
|
required: false,
|
|
29665
29929
|
description: "One to five paragraphs of writing in the intended voice; these paragraphs are what reach a writer, so choose them carefully."
|
|
29666
29930
|
},
|
|
29931
|
+
{
|
|
29932
|
+
name: "pictures",
|
|
29933
|
+
type: "array",
|
|
29934
|
+
itemType: "object",
|
|
29935
|
+
required: false,
|
|
29936
|
+
description: "Picture samples to store with the style, in the order you send them; a bare file identifier is stored as a picture with no name and no description."
|
|
29937
|
+
},
|
|
29938
|
+
{
|
|
29939
|
+
name: "work",
|
|
29940
|
+
type: "string",
|
|
29941
|
+
required: false,
|
|
29942
|
+
description: "Work this style should belong to, by its wk_ identifier; pass it so the work can attach the style later, since a work may only use its own styles. Omit it for a style that belongs to no single work."
|
|
29943
|
+
},
|
|
29667
29944
|
{
|
|
29668
29945
|
name: "use",
|
|
29669
29946
|
type: "array",
|
|
@@ -29727,7 +30004,7 @@ for more details.`
|
|
|
29727
30004
|
resource: "studio.styles",
|
|
29728
30005
|
method: "update",
|
|
29729
30006
|
summary: "Change a writing style",
|
|
29730
|
-
description: "Change a style: its name, its description, its samples, its use and avoid lists, or its glossary. Send update_mask naming exactly the fields you change; a list the mask names is replaced whole. Adding a term to the glossary or to avoid also changes what the deterministic checks flag, so a work that uses this style sees new findings on its next check.",
|
|
30007
|
+
description: "Change a style: its name, its description, its samples, its picture samples, its use and avoid lists, or its glossary. Send update_mask naming exactly the fields you change; a list the mask names is replaced whole. Adding a term to the glossary or to avoid also changes what the deterministic checks flag, so a work that uses this style sees new findings on its next check.",
|
|
29731
30008
|
http: "PATCH",
|
|
29732
30009
|
path: "/studio/v1/styles/{style}",
|
|
29733
30010
|
streaming: "no",
|
|
@@ -29769,6 +30046,13 @@ for more details.`
|
|
|
29769
30046
|
required: false,
|
|
29770
30047
|
description: "Complete set of sample paragraphs, replacing the previous ones; removing a sample removes it from every later context pack."
|
|
29771
30048
|
},
|
|
30049
|
+
{
|
|
30050
|
+
name: "pictures",
|
|
30051
|
+
type: "array",
|
|
30052
|
+
itemType: "object",
|
|
30053
|
+
required: false,
|
|
30054
|
+
description: "Complete picture gallery for this style, replacing the previous one and keeping the order you send; a picture left out stops being shown."
|
|
30055
|
+
},
|
|
29772
30056
|
{
|
|
29773
30057
|
name: "use",
|
|
29774
30058
|
type: "array",
|
|
@@ -30140,7 +30424,7 @@ for more details.`
|
|
|
30140
30424
|
resource: "studio.works",
|
|
30141
30425
|
method: "create",
|
|
30142
30426
|
summary: "Create a work with its goal",
|
|
30143
|
-
description: "Create a work: one deliverable piece plus everything around it. Pass the goal the writing serves — the reader, what that reader should get or do, the one-sentence message and the constraints — and the original brief the person gave in their own words. A slug is derived from the title unless you pass one. The work starts with no drafts; create the first one with the drafts create call, because the genre decides the structure.",
|
|
30427
|
+
description: "Create a work: one deliverable piece plus everything around it. Pass the goal the writing serves — the reader, what that reader should get or do, the one-sentence message and the constraints — and the original brief the person gave in their own words. A slug is derived from the title unless you pass one. The work starts with no drafts; create the first one with the drafts create call, because the genre decides the structure. A reference library belongs to the work and is created with it, so the setting written later stays this work's own; pass based_on to start from another work and have its setting and styles copied in as your own.",
|
|
30144
30428
|
http: "POST",
|
|
30145
30429
|
path: "/studio/v1/works",
|
|
30146
30430
|
streaming: "no",
|
|
@@ -30179,13 +30463,25 @@ for more details.`
|
|
|
30179
30463
|
type: "array",
|
|
30180
30464
|
itemType: "string",
|
|
30181
30465
|
required: false,
|
|
30182
|
-
description: "
|
|
30466
|
+
description: "Shared reference libraries to attach at creation, on top of the work's own library, which is always created with it; a library owned by another organization is refused rather than attached."
|
|
30183
30467
|
},
|
|
30184
30468
|
{
|
|
30185
30469
|
name: "style",
|
|
30186
30470
|
type: "string",
|
|
30187
30471
|
required: false,
|
|
30188
|
-
description: "Style to attach to the work, whose samples and glossary then reach every context pack unless a draft overrides it."
|
|
30472
|
+
description: "Style to attach to the work, whose samples and glossary then reach every context pack unless a draft overrides it. A new work has no styles of its own yet, so leave this out and attach one after creating a style with work set to this work."
|
|
30473
|
+
},
|
|
30474
|
+
{
|
|
30475
|
+
name: "cover",
|
|
30476
|
+
type: "string",
|
|
30477
|
+
required: false,
|
|
30478
|
+
description: "Cover image for the work, by a file identifier that belongs to this organization; leave it out for a work with no cover."
|
|
30479
|
+
},
|
|
30480
|
+
{
|
|
30481
|
+
name: "based_on",
|
|
30482
|
+
type: "string",
|
|
30483
|
+
required: false,
|
|
30484
|
+
description: "Work to copy at creation, by its wk_ identifier or its slug: its own library's entries, its styles and the style it uses come into this new work as its own copies, and the source is recorded as this work's baseline. The two works are independent afterwards, and drafts are not copied. Use it to start a sequel or a variant from an existing setting instead of rebuilding the setting; a source work this organization does not own answers BASELINE_NOT_FOUND."
|
|
30189
30485
|
},
|
|
30190
30486
|
{
|
|
30191
30487
|
name: "labels",
|
|
@@ -30308,7 +30604,13 @@ for more details.`
|
|
|
30308
30604
|
name: "style",
|
|
30309
30605
|
type: "string",
|
|
30310
30606
|
required: false,
|
|
30311
|
-
description: "Style to attach to the work, replacing the previous one; send an empty value to detach the style entirely."
|
|
30607
|
+
description: "Style to attach to the work, replacing the previous one; send an empty value to detach the style entirely. It must be one of this work's own styles — name a style created with work set to this work — and the style of another work is refused with STYLE_NOT_IN_WORK."
|
|
30608
|
+
},
|
|
30609
|
+
{
|
|
30610
|
+
name: "cover",
|
|
30611
|
+
type: "string",
|
|
30612
|
+
required: false,
|
|
30613
|
+
description: "Cover image to set, by a file identifier that belongs to this organization, replacing the previous cover; send null with cover named in the update mask to clear the cover."
|
|
30312
30614
|
},
|
|
30313
30615
|
{
|
|
30314
30616
|
name: "labels",
|
|
@@ -41316,6 +41618,59 @@ var mediaCreateSpeech = (options) => (options.client ?? client).post({
|
|
|
41316
41618
|
...options.headers
|
|
41317
41619
|
}
|
|
41318
41620
|
});
|
|
41621
|
+
var mediaCreateVoiceConsent = (options) => (options.client ?? client).post({
|
|
41622
|
+
security: [{
|
|
41623
|
+
key: "media-BearerAuth",
|
|
41624
|
+
scheme: "bearer",
|
|
41625
|
+
type: "http"
|
|
41626
|
+
}],
|
|
41627
|
+
url: "/media/v1/libraries/{library_id}/voice_consents",
|
|
41628
|
+
...options,
|
|
41629
|
+
headers: {
|
|
41630
|
+
"Content-Type": "application/json",
|
|
41631
|
+
...options.headers
|
|
41632
|
+
}
|
|
41633
|
+
});
|
|
41634
|
+
var mediaListVoices = (options) => (options.client ?? client).get({
|
|
41635
|
+
security: [{
|
|
41636
|
+
key: "media-BearerAuth",
|
|
41637
|
+
scheme: "bearer",
|
|
41638
|
+
type: "http"
|
|
41639
|
+
}],
|
|
41640
|
+
url: "/media/v1/libraries/{library_id}/voices",
|
|
41641
|
+
...options
|
|
41642
|
+
});
|
|
41643
|
+
var mediaCreateVoice = (options) => (options.client ?? client).post({
|
|
41644
|
+
security: [{
|
|
41645
|
+
key: "media-BearerAuth",
|
|
41646
|
+
scheme: "bearer",
|
|
41647
|
+
type: "http"
|
|
41648
|
+
}],
|
|
41649
|
+
url: "/media/v1/libraries/{library_id}/voices",
|
|
41650
|
+
...options,
|
|
41651
|
+
headers: {
|
|
41652
|
+
"Content-Type": "application/json",
|
|
41653
|
+
...options.headers
|
|
41654
|
+
}
|
|
41655
|
+
});
|
|
41656
|
+
var mediaDeleteVoice = (options) => (options.client ?? client).delete({
|
|
41657
|
+
security: [{
|
|
41658
|
+
key: "media-BearerAuth",
|
|
41659
|
+
scheme: "bearer",
|
|
41660
|
+
type: "http"
|
|
41661
|
+
}],
|
|
41662
|
+
url: "/media/v1/libraries/{library_id}/voices/{voice_id}",
|
|
41663
|
+
...options
|
|
41664
|
+
});
|
|
41665
|
+
var mediaGetVoice = (options) => (options.client ?? client).get({
|
|
41666
|
+
security: [{
|
|
41667
|
+
key: "media-BearerAuth",
|
|
41668
|
+
scheme: "bearer",
|
|
41669
|
+
type: "http"
|
|
41670
|
+
}],
|
|
41671
|
+
url: "/media/v1/libraries/{library_id}/voices/{voice_id}",
|
|
41672
|
+
...options
|
|
41673
|
+
});
|
|
41319
41674
|
var mediaUnderstandingFailureSummary = (options) => (options.client ?? client).get({
|
|
41320
41675
|
security: [{
|
|
41321
41676
|
key: "media-BearerAuth",
|
|
@@ -42141,6 +42496,38 @@ var getSandboxV1SandboxesBySandboxIdLogs = (options) => (options.client ?? clien
|
|
|
42141
42496
|
url: "/sandbox/v1/sandboxes/{sandboxID}/logs",
|
|
42142
42497
|
...options
|
|
42143
42498
|
});
|
|
42499
|
+
var getSandboxEvents = (options) => (options.client ?? client).get({
|
|
42500
|
+
security: [
|
|
42501
|
+
{
|
|
42502
|
+
key: "sandbox-ApiKeyAuth",
|
|
42503
|
+
name: "X-API-Key",
|
|
42504
|
+
type: "apiKey"
|
|
42505
|
+
},
|
|
42506
|
+
{
|
|
42507
|
+
key: "sandbox-AuthProviderBearerAuth",
|
|
42508
|
+
scheme: "bearer",
|
|
42509
|
+
type: "http"
|
|
42510
|
+
},
|
|
42511
|
+
{
|
|
42512
|
+
key: "sandbox-AuthProviderTeamAuth",
|
|
42513
|
+
name: "X-Team-ID",
|
|
42514
|
+
type: "apiKey"
|
|
42515
|
+
},
|
|
42516
|
+
{ name: "X-Admin-Token", type: "apiKey" },
|
|
42517
|
+
{
|
|
42518
|
+
key: "sandbox-AdminTeamAuth",
|
|
42519
|
+
name: "X-Team-ID",
|
|
42520
|
+
type: "apiKey"
|
|
42521
|
+
},
|
|
42522
|
+
{
|
|
42523
|
+
key: "sandbox-AdminJWTAuth",
|
|
42524
|
+
scheme: "bearer",
|
|
42525
|
+
type: "http"
|
|
42526
|
+
}
|
|
42527
|
+
],
|
|
42528
|
+
url: "/sandbox/v1/events/sandboxes/{sandboxID}",
|
|
42529
|
+
...options
|
|
42530
|
+
});
|
|
42144
42531
|
var startTemplateBuild = (options) => (options.client ?? client).post({
|
|
42145
42532
|
security: [
|
|
42146
42533
|
{
|
|
@@ -45179,7 +45566,16 @@ function createMedia(transport) {
|
|
|
45179
45566
|
list: bindPage(transport, mediaListUnderstandingsByLibrary),
|
|
45180
45567
|
retrieveFailureSummary: bind(transport, mediaUnderstandingFailureSummary)
|
|
45181
45568
|
},
|
|
45182
|
-
update: bind(transport, mediaUpdateLibrary)
|
|
45569
|
+
update: bind(transport, mediaUpdateLibrary),
|
|
45570
|
+
voiceConsents: {
|
|
45571
|
+
create: bind(transport, mediaCreateVoiceConsent)
|
|
45572
|
+
},
|
|
45573
|
+
voices: {
|
|
45574
|
+
create: bind(transport, mediaCreateVoice),
|
|
45575
|
+
delete: bind(transport, mediaDeleteVoice),
|
|
45576
|
+
list: bindPage(transport, mediaListVoices),
|
|
45577
|
+
retrieve: bind(transport, mediaGetVoice)
|
|
45578
|
+
}
|
|
45183
45579
|
},
|
|
45184
45580
|
speech: {
|
|
45185
45581
|
create: bind(transport, mediaCreateSpeech)
|
|
@@ -45352,6 +45748,11 @@ function createOrganization(transport) {
|
|
|
45352
45748
|
}
|
|
45353
45749
|
function createSandbox(transport) {
|
|
45354
45750
|
return {
|
|
45751
|
+
events: {
|
|
45752
|
+
sandboxes: {
|
|
45753
|
+
retrieve: bind(transport, getSandboxEvents)
|
|
45754
|
+
}
|
|
45755
|
+
},
|
|
45355
45756
|
sandboxes: {
|
|
45356
45757
|
commands: {
|
|
45357
45758
|
run: bind(transport, runSandboxCommand)
|
|
@@ -52821,7 +53222,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
52821
53222
|
}
|
|
52822
53223
|
|
|
52823
53224
|
// src/main.ts
|
|
52824
|
-
var version = "0.3.0-dev.
|
|
53225
|
+
var version = "0.3.0-dev.b478c75";
|
|
52825
53226
|
var commands = commandTree(operations);
|
|
52826
53227
|
var manual = [...workflows.map((w) => w.words), [API_WORD]];
|
|
52827
53228
|
function route(argv) {
|