Skip to content

Remove Clip from Collection#

Removes a clip from a manually curated collection.

Endpoint#

DELETE /api/app/collections/{id}/clip/{clipId}

Parameters#

Path Parameters#

Parameter Type Required Description
id string Yes The unique identifier of the collection
clipId string Yes The unique identifier of the clip to remove

Authentication#

This endpoint requires authentication using your API key. See Authentication for details.

Request#

Headers#

x-storyteller-api-key: your-api-key-here

Example Request#

DELETE /api/app/collections/12345678-1234-1234-1234-123456789abc/clip/87654321-4321-4321-4321-cba987654321
Host: cmsapi.localhost
x-storyteller-api-key: your-api-key-here

Response#

Success Response#

Status Code: 200 OK

No response body.

Error Responses#

Status Code: 400 Bad Request

{
  "error": "BadRequest",
  "message": "Invalid collection ID or clip ID"
}

Status Code: 401 Unauthorized

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}

Code Examples#

const response = await fetch(
  'https://cmsapi.localhost/api/app/collections/12345678-1234-1234-1234-123456789abc/clip/87654321-4321-4321-4321-cba987654321',
  {
    method: 'DELETE',
    headers: {
      'x-storyteller-api-key': 'your-api-key-here'
    }
  }
);

console.log(response.status);
import requests

url = "https://cmsapi.localhost/api/app/collections/12345678-1234-1234-1234-123456789abc/clip/87654321-4321-4321-4321-cba987654321"
headers = {
    "x-storyteller-api-key": "your-api-key-here"
}

response = requests.delete(url, headers=headers)
print(response.status_code)
using HttpClient client = new HttpClient();

client.DefaultRequestHeaders.Add("x-storyteller-api-key", "your-api-key-here");

var response = await client.DeleteAsync(
  "https://cmsapi.localhost/api/app/collections/12345678-1234-1234-1234-123456789abc/clip/87654321-4321-4321-4321-cba987654321"
);

Console.WriteLine((int)response.StatusCode);
curl -X DELETE \
  -H "x-storyteller-api-key: your-api-key-here" \
  "https://cmsapi.localhost/api/app/collections/12345678-1234-1234-1234-123456789abc/clip/87654321-4321-4321-4321-cba987654321"

Notes#

  • This endpoint removes the collection-to-clip association only.
  • The clip itself is not deleted.
  • The operation is idempotent; removing a clip that is already not in the collection still returns success.