Skip to content

by Startups.Studio

Product Brand Voice

Voice.retire

POST /{namespace}/voices/{voice}/retire

Retire deletes a Voice’s trained copy at the upstream and refuses new speech in it, keeping the record and every File made.

Noun: Voice
Mode: do
Event: Voice.retired

You, to your agent

Retire the latest voice.

curl -X POST https://api.sb/shiftnote.app/voices/voice_1/retire \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const voice = await $.Voice.retire({ voice: 'voice_1' })

npx startup-builder do Voice.retire --json '{"voice":"voice_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Voice.retire({ voice: 'voice_1' })"
  }
}

Inputs

Input	Type	Required	Description
`voice`	Voice	required	The Voice to retire.
`reason`	`text`		Why, such as Consent withdrawn.

Outputs

Output	Type	Required	Description
`voice`	Voice	required	The Voice, now `retired`.

Effects

Emits Voice.retired.
Performed by the Privacy Officer.
One-way (brand): it waits out its delay window, and runs in the send and do modes.
Runs at once when the speaker withdraws Consent.
Deletes nothing in db.sb.

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.retire

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (brand)
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
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.list

Previous Page

Voice.update

Next Page