---
title: "Get Recording Setup"
method: GET
path: "/v1/campaigns/{campaign_id}/recordings/setup"
tags: ["recordings", "product-api"]
---

# Get Recording Setup

`GET /v1/campaigns/{campaign_id}/recordings/setup`

## Request

- Base URL: `https://api.myarchivist.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.myarchivist.ai/v1/campaigns/{campaign_id}/recordings/setup`
- Auth: HTTP bearer

## Path parameters

- `campaign_id` string, required

## Headers

- `x-api-key` string, nullable

## Response `200`

Successful Response

- RecordingSetupResponse
  - `speakers` RecordingSetupSpeaker[]
    - `id` string, required
    - `display_name` string, required
    - `name` string, nullable
    - `handle` string, nullable
    - `default` boolean
    - `roles` string[]
    - `character_names` string[]
    - `has_voice_sample` boolean
    - `needs_voice_sample` boolean
  - `available_characters` RecordingSetupCharacterOption[]
    - `id` string, required
    - `character_name` string, required
    - `type` string, required
  - `recording_available` boolean
  - `recording_blocked_reason` string, nullable
  - `recording_blocked_message` string, nullable
  - `recording_blocked_code` string, nullable
  - `recording_blocked_can_resolve` boolean

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/myarchivist/apis/archivist-public-api.md) · [All operations](https://skmtc.dev/myarchivist/apis/archivist-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/myarchivist/apis/archivist-public-api/revisions/3ea6ca7efc56?raw)
