# Voice routes: get, list, update

URL: /code/api/voice/records · Id: `page:code/api/voice/records`

> The Voice Verbs get, list, update as api.sb routes, with inputs, result, refusals and an example.

Reference for [Voice](/business/nouns/voice), one group of [Voice routes](/code/api/voice).

### Voice.get
Returns one Voice by id. [Verb page](/business/nouns/voice/get?interface=api).

```text
GET /{namespace}/voices/{id}
```

Path: `id`. Query: the other inputs. Reads only: it emits no Event.

**Inputs**

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `voice` | [Voice](/business/nouns/voice) | Yes | The Voice. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl https://api.sb/leaseline.app/voices/voice_s6Qb8KW683 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Voice",
  "$id": "https://api.sb/leaseline.app/voices/voice_s6Qb8KW683",
  "voice": {
    "$id": "https://api.sb/leaseline.app/voices/voice_s6Qb8KW683",
    "$type": "Voice",
    "origin": "cloned",
    "scope": "studio",
    "status": "training"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/voices/voice_s6Qb8KW683",
    "up": "https://api.sb/leaseline.app/voices"
  },
  "actions": {
    "retire": "https://api.sb/leaseline.app/voices/voice_s6Qb8KW683/retire"
  }
}
```

### Voice.list
Returns Voices, newest first, one page at a time. [Verb page](/business/nouns/voice/list?interface=api).

```text
GET /{namespace}/voices
```

Query: the inputs. Reads only: it emits no Event.

**Inputs**

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `voices` | list of [Voice](/business/nouns/voice) | Yes | One page of Voices. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl "https://api.sb/leaseline.app/voices?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Voice",
  "voices": [
    {
      "$id": "https://api.sb/leaseline.app/voices/voice_s6Qb8KW683",
      "$type": "Voice",
      "origin": "cloned",
      "scope": "studio",
      "status": "training"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "voice_s6Qb8KW683"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/voices?limit=20",
    "next": "https://api.sb/leaseline.app/voices?after=voice_s6Qb8KW683"
  }
}
```

### Voice.update
Changes the given properties of a Voice. [Verb page](/business/nouns/voice/update?interface=api).

```text
PATCH /{namespace}/voices/{id}
```

Path: `id`. Body, as JSON: the other inputs. Emits `Voice.updated`.

**Inputs**

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `voice` | [Voice](/business/nouns/voice) | Yes | The Voice. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl -X PATCH https://api.sb/leaseline.app/voices/voice_s6Qb8KW683 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"origin":"cloned"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "voice": {
    "$id": "https://api.sb/leaseline.app/voices/voice_s6Qb8KW683",
    "$type": "Voice",
    "origin": "cloned",
    "scope": "studio",
    "status": "training"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Voice.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```