Skip to content

by Startups.Studio

Product Brand Voice

Voice.update

PATCH /{namespace}/voices/{id}

Changes the given properties of a Voice.

Noun: Voice
Mode: do
Event: Voice.updated

You, to your agent

Change the latest voice.

curl -X PATCH https://api.sb/routewise.dev/voices/voice_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"origin":"cloned"}'

import { $ } from 'startup-builder'

const voice = await $.Voice.update({ id: 'voice_1', origin: 'cloned' })

npx startup-builder do Voice.update --json '{"id":"voice_1","origin":"cloned"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Voice.update({ id: 'voice_1', origin: 'cloned' })"
  }
}

Update changes the given properties of a Voice. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Voice.
`origin`	`string`		`cloned` from a real speaker’s recordings, or `designed` from a description and sounding like no real person.
`speaker`	Person		The real person a cloned Voice sounds like.
`consent`	Consent		The speaker’s Consent, recorded in that voice, naming the Startup and the uses allowed; required for a cloned Voice. Never randomized.
`scope`	`string`		Who may speak in it: every sibling, one Startup, or one Customer.
`samples`	list of File		The recordings it was trained from, kept forever.

Outputs

Output	Type	Required	Description
`voice`	Voice	required	The Voice.

Effects

Emits Voice.updated.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Voice.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Voice.retire

Previous Page

Domains and access

Next Page