# Actors

> SDK methods for the Actors module, accessed via `soat.actors`. See the [Actors module docs](/docs/modules/actors) for permissions and data model, and each method's REST page for the full request/response schema.

# Actors

SDK methods for the Actors module, accessed via `soat.actors`. See the [Actors module docs](/docs/modules/actors) for permissions and data model, and each method's REST page for the full request/response schema.

### `soat.actors.listActors()`

List actors

- Method: `GET`
- Path: `/api/v1/actors`

```ts
await soat.actors.listActors({
  query: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/actors/list-actors)

### `soat.actors.createActor()`

Create an actor

- Method: `POST`
- Path: `/api/v1/actors`

```ts
await soat.actors.createActor({
  body: { name, /* + optional */ },
});
```

→ [Request & response schema](/docs/api/actors/create-actor)

### `soat.actors.getActor()`

Get an actor by ID

- Method: `GET`
- Path: `/api/v1/actors/{actor_id}`

```ts
await soat.actors.getActor({
  path: { actor_id },
});
```

→ [Request & response schema](/docs/api/actors/get-actor)

### `soat.actors.deleteActor()`

Delete an actor

- Method: `DELETE`
- Path: `/api/v1/actors/{actor_id}`

```ts
await soat.actors.deleteActor({
  path: { actor_id },
});
```

→ [Request & response schema](/docs/api/actors/delete-actor)

### `soat.actors.updateActor()`

Update an actor

- Method: `PATCH`
- Path: `/api/v1/actors/{actor_id}`

```ts
await soat.actors.updateActor({
  path: { actor_id },
  body: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/actors/update-actor)

### `soat.actors.getActorTags()`

Get actor tags

- Method: `GET`
- Path: `/api/v1/actors/{actor_id}/tags`

```ts
await soat.actors.getActorTags({
  path: { actor_id },
});
```

→ [Request & response schema](/docs/api/actors/get-actor-tags)

### `soat.actors.replaceActorTags()`

Replace actor tags

- Method: `PUT`
- Path: `/api/v1/actors/{actor_id}/tags`

```ts
await soat.actors.replaceActorTags({
  path: { actor_id },
  body,
});
```

→ [Request & response schema](/docs/api/actors/replace-actor-tags)

### `soat.actors.mergeActorTags()`

Merge actor tags

- Method: `PATCH`
- Path: `/api/v1/actors/{actor_id}/tags`

```ts
await soat.actors.mergeActorTags({
  path: { actor_id },
  body,
});
```

→ [Request & response schema](/docs/api/actors/merge-actor-tags)