---
title: "Connect new speaker"
method: POST
path: "/speakers/"
tags: ["speakers"]
---

# Connect new speaker

`POST /speakers/`

## Request

- Base URL: `https://api.angelcam.com/v1`
- URL: `https://api.angelcam.com/v1/speakers/`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://my.angelcam.com/oauth/authorize/`, token URL `https://my.angelcam.com/oauth/token/`
    - Password, token URL `https://api.angelcam.com/oauth/token/`
    - Scopes: `speaker_manage`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/angelcam/apis/angelcam-api/docs/speakers/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- SpeakerObject
  - `id` integer, required: Speaker ID
  - `name` string, required: Speaker name
  - `setup` 'arrow', required: Speaker connection type
  - `protocol` 'basic', required: Audio protocol
  - `arrow_client` string, uuid, nullable: UUID of arrow client client used for speaker connection, required when setup=arrow
  - `arrow_service_id` string, nullable: hexadecimal id of arrow service, can contain leading zeros, required when setup=arrow
  - `endpoint` string, uri, required: Endpoint URL for the speaker
  - `username` string
  - `password` string

## Response `201`

Newly created speaker object.

- SpeakerObject
  - `id` integer, required: Speaker ID
  - `name` string, required: Speaker name
  - `setup` 'arrow', required: Speaker connection type
  - `protocol` 'basic', required: Audio protocol
  - `arrow_client` string, uuid, nullable: UUID of arrow client client used for speaker connection, required when setup=arrow
  - `arrow_service_id` string, nullable: hexadecimal id of arrow service, can contain leading zeros, required when setup=arrow
  - `endpoint` string, uri, required: Endpoint URL for the speaker
  - `username` string
  - `password` string

## Other responses

- `400`: Body payload is invalid.
- `401`: Missing or invalid authorization.
- `403`: Missing permission.

---

[API](https://skmtc.dev/angelcam/apis/angelcam-api.md) - [All operations](https://skmtc.dev/angelcam/apis/angelcam-api/llms.txt) - [OpenAPI document](https://skmtc.dev/angelcam/apis/angelcam-api/revisions/dd1cdc3f2c23?raw)
