# List the Cast

`GET https://api.vidmoat.com/v1/cast`

- Scope: `cast.read`
- Cost: Free

Every saved member with its reference images, views and voice. Face prints are never returned.

### Query parameters

- `kind` (enum, optional): Only this kind. One of `character`, `location`, `prop`, `style`.

## Response

Returns `200`.

### Response fields

- `members` (array): `{ id, kind, name, description?, references, voice?, identity? }`.

## Request examples

```bash curl
curl "https://api.vidmoat.com/v1/cast?kind=character" \
  -H "Authorization: Bearer $VIDMOAT_KEY"
```

```js Node
const res = await fetch('https://api.vidmoat.com/v1/cast?kind=character', {
  headers: {
    Authorization: `Bearer ${process.env.VIDMOAT_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error?.message ?? `HTTP ${res.status}`);
console.log(data);
```

```python Python
import os
import requests

res = requests.get(
    "https://api.vidmoat.com/v1/cast?kind=character",
    headers={"Authorization": f"Bearer {os.environ['VIDMOAT_KEY']}"},
    timeout=60,
)
res.raise_for_status()
print(res.json())
```

## Example response

```json
{ "members": [{
  "id": "cm_5f2a9c1d7e3b",
  "kind": "character",
  "name": "Mara",
  "description": "white spiky hair, black mask, red scarf, number 7 on the chest",
  "references": [{ "id": "cr_81b2", "url": "https://api.vidmoat.com/uploads/mara-front.png", "view": "front", "source": "upload", "approved": true, "hasFace": true }],
  "identity": { "method": "sface-2021dec", "ceiling": null, "refs": 1 }
}] }
```

---

Source: https://developer.vidmoat.com/developer/docs/api/cast/list-cast
Previous: [Run the editing agent](https://developer.vidmoat.com/developer/docs/api/generation/run-agent.md)
Next: [Create a cast member](https://developer.vidmoat.com/developer/docs/api/cast/create-cast-member.md)
All documentation: https://developer.vidmoat.com/llms-full.txt