Voice programs: get, list, update

Reference for Voice, one group of Voice programs.

Voice.get

Returns one Voice by id. Verb page.

Text

do: return await $.Voice.get(input)

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Voice.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

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

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

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Voice.get({ id: 'voice_s6Qb8KW683' })"
  }
}

Returns Voices, newest first, one page at a time. Verb page.

Text

do: return await $.Voice.list(input)

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`voices`	list of Voice	required	One page of Voices.

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

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Voice.list({ limit: 20 })"
  }
}

Changes the given properties of a Voice. Verb page.

Text

do: return await $.Voice.update(input)

Emits Voice.updated.

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.

Returns

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

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

Example

JSON

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