---
title: "Add an object to the localplay server"
method: POST
path: "/localplay/add"
tags: ["Playback Control"]
---

# Add an object to the localplay server

`POST /localplay/add`

This is for controlling localplay

## Query parameters

- `filter` string
- `type` 'song' | 'video' | 'podcast_episode' | 'broadcast' | 'live_stream' | 'democratic'
- `clear` 0 | 1

## Request body

- LocalplayLocalplayAddRequest
  - `filter` string, required — Object id
  - `type` 'song' | 'video' | 'podcast_episode' | 'broadcast' | 'live_stream' | 'democratic'
  - `clear` 0 | 1 — Clear the current playlist before adding

## Response `200`

Localplay response

- LocalplayResponse — The command name maps to `true` when the controller accepted it, `false` when it did not.
  - `localplay` object, required
    - `command` object, required

## Other responses

- `400` — HTTP 400 Bad Request (errors 4705, 4710).
- `401` — HTTP 401 Unauthorized (error 4701).
- `403` — HTTP 403 Forbidden (errors 4700, 4703, 4742).
- `404` — HTTP 404 Not Found (error 4704).
- `500` — HTTP 500 Internal Server Error (error 4702).

## Changes

> 46 revisions in range; 8 could not be searched.

- **2026-07-23** `da9583d68382` — 9 info
  - added the new enum value `broadcast` to the `query` request parameter `type`
  - added the new enum value `democratic` to the `query` request parameter `type`
  - added the new enum value `live_stream` to the `query` request parameter `type`
  - added the new `broadcast` enum value to the request property `type` (media type: application/json)
  - …5 more
- **2026-07-22** `e8e6b266ea29` — 7 info
  - api operation id `localplayAdd` was added
  - added optional request body
  - the `query` request parameter `filter` became optional
  - added the non-success response with the status `401`
  - …3 more
- **2026-07-21** `2ff18e50dcc1` — 1 info
  - added the required property `localplay` to the response with the `200` status
- **2026-07-11** `2db906b9afb1` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/ampache/apis/ampache-rest-api/changes/localplay/add/post.md)

---

[API](https://skmtc.dev/ampache/apis/ampache-rest-api.md) · [All operations](https://skmtc.dev/ampache/apis/ampache-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ampache/ampache-rest-api/revisions/42d304fb6867/schema)