API reference / Collections

Reorder collection items

PUT/v1/collections/{id}/order

Collections use the same rules as the website. A sound board is a collection with kind board. Limits are counted per kind: free accounts can hold 1 collection and 1 sound board; Pro accounts can hold up to 1,000 of each and create up to 60 per hour. A collection holds at most 500 tracks. A lapsed Pro account can view everything but can edit only one collection and one sound board until it resubscribes. Adding a CC BY-NC track to a commercial collection, or marking a collection with CC BY-NC tracks commercial, returns nc_commercial. Collection PATCH requires the current revision. Item edits, reorder, and adds accept an optional revision guard; deletion requires explicit confirmation.

Needs an API key. Send it in the Authorization: Bearer header.

Get a key

Parameters

NameInTypeDescription
id requiredPathstring

Request body required

Content type: application/json

NameTypeDescription
tracks requiredarray of string
revision optionalinteger Minimum: 1

Responses

  • 200 OK.

    Schema CollectionDetail · Content: application/json

  • 400 The request is not valid. When error is invalid_order, tracks is not exactly the collection’s tracks, each once: missing lists the collection’s tracks that tracks left out, and unknown lists ids in tracks that the collection does not hold. A duplicate or a wrong count with no missing or unknown id returns both as empty arrays.

    object · Content: application/json

    Error fields (10)
    NameTypeDescription
    error requiredstringA short code: missing_api_key, invalid_api_key, invalid_parameter, invalid_filter_for_kind, not_found, rate_limited, method_not_allowed, or internal_error.
    message requiredstringWhat went wrong, in plain words.
    parameter optionalstringOn invalid_parameter and invalid_filter_for_kind, the invalid parameter or field.
    invalid_values optionalarray of stringUnknown controlled filter ids.
    discovery optionalstringThe endpoint listing valid filter ids and labels.
    limit optionalstringOnly on rate_limited: which limit you hit. One of: minute, day, month
    retry_after optionalnumberOnly on rate_limited: seconds to wait before retrying.
    reset_at optionalstringOnly on rate_limited: when that limit resets, as an ISO 8601 UTC time.
    missing optionalarray of stringOnly with invalid_order: track ids in the collection that tracks left out.
    unknown optionalarray of stringOnly with invalid_order: ids in tracks that are not in the collection.
  • 401 The API key is missing, not valid, or revoked.

    Schema Error · Content: application/json

    Error fields (8)
    NameTypeDescription
    error requiredstringA short code: missing_api_key, invalid_api_key, invalid_parameter, invalid_filter_for_kind, not_found, rate_limited, method_not_allowed, or internal_error.
    message requiredstringWhat went wrong, in plain words.
    parameter optionalstringOn invalid_parameter and invalid_filter_for_kind, the invalid parameter or field.
    invalid_values optionalarray of stringUnknown controlled filter ids.
    discovery optionalstringThe endpoint listing valid filter ids and labels.
    limit optionalstringOnly on rate_limited: which limit you hit. One of: minute, day, month
    retry_after optionalnumberOnly on rate_limited: seconds to wait before retrying.
    reset_at optionalstringOnly on rate_limited: when that limit resets, as an ISO 8601 UTC time.
  • 403 The collection is currently read-only.

    Schema Error · Content: application/json

    Error fields (8)
    NameTypeDescription
    error requiredstringA short code: missing_api_key, invalid_api_key, invalid_parameter, invalid_filter_for_kind, not_found, rate_limited, method_not_allowed, or internal_error.
    message requiredstringWhat went wrong, in plain words.
    parameter optionalstringOn invalid_parameter and invalid_filter_for_kind, the invalid parameter or field.
    invalid_values optionalarray of stringUnknown controlled filter ids.
    discovery optionalstringThe endpoint listing valid filter ids and labels.
    limit optionalstringOnly on rate_limited: which limit you hit. One of: minute, day, month
    retry_after optionalnumberOnly on rate_limited: seconds to wait before retrying.
    reset_at optionalstringOnly on rate_limited: when that limit resets, as an ISO 8601 UTC time.
  • 404 The collection or item was not found or is not owned by this account.

    Schema Error · Content: application/json

    Error fields (8)
    NameTypeDescription
    error requiredstringA short code: missing_api_key, invalid_api_key, invalid_parameter, invalid_filter_for_kind, not_found, rate_limited, method_not_allowed, or internal_error.
    message requiredstringWhat went wrong, in plain words.
    parameter optionalstringOn invalid_parameter and invalid_filter_for_kind, the invalid parameter or field.
    invalid_values optionalarray of stringUnknown controlled filter ids.
    discovery optionalstringThe endpoint listing valid filter ids and labels.
    limit optionalstringOnly on rate_limited: which limit you hit. One of: minute, day, month
    retry_after optionalnumberOnly on rate_limited: seconds to wait before retrying.
    reset_at optionalstringOnly on rate_limited: when that limit resets, as an ISO 8601 UTC time.
  • 409 A collection limit or revision conflict prevented the write.

    Schema Error · Content: application/json

    Error fields (8)
    NameTypeDescription
    error requiredstringA short code: missing_api_key, invalid_api_key, invalid_parameter, invalid_filter_for_kind, not_found, rate_limited, method_not_allowed, or internal_error.
    message requiredstringWhat went wrong, in plain words.
    parameter optionalstringOn invalid_parameter and invalid_filter_for_kind, the invalid parameter or field.
    invalid_values optionalarray of stringUnknown controlled filter ids.
    discovery optionalstringThe endpoint listing valid filter ids and labels.
    limit optionalstringOnly on rate_limited: which limit you hit. One of: minute, day, month
    retry_after optionalnumberOnly on rate_limited: seconds to wait before retrying.
    reset_at optionalstringOnly on rate_limited: when that limit resets, as an ISO 8601 UTC time.
  • 413 The JSON body exceeds 64 KB.

    Schema Error · Content: application/json

    Error fields (8)
    NameTypeDescription
    error requiredstringA short code: missing_api_key, invalid_api_key, invalid_parameter, invalid_filter_for_kind, not_found, rate_limited, method_not_allowed, or internal_error.
    message requiredstringWhat went wrong, in plain words.
    parameter optionalstringOn invalid_parameter and invalid_filter_for_kind, the invalid parameter or field.
    invalid_values optionalarray of stringUnknown controlled filter ids.
    discovery optionalstringThe endpoint listing valid filter ids and labels.
    limit optionalstringOnly on rate_limited: which limit you hit. One of: minute, day, month
    retry_after optionalnumberOnly on rate_limited: seconds to wait before retrying.
    reset_at optionalstringOnly on rate_limited: when that limit resets, as an ISO 8601 UTC time.
  • 429 Over your plan's limit. Free accounts get 20 calls per minute and 300 calls per day. Pro accounts get 60 calls per minute and 20,000 calls per month (UTC). MCP and the API share one allowance per account. The Retry-After header gives the seconds to wait, up to 86,400, and the limit and reset_at fields in the body name the limit you hit and when it resets.

    Schema Error · Content: application/json

    Error fields (8)
    NameTypeDescription
    error requiredstringA short code: missing_api_key, invalid_api_key, invalid_parameter, invalid_filter_for_kind, not_found, rate_limited, method_not_allowed, or internal_error.
    message requiredstringWhat went wrong, in plain words.
    parameter optionalstringOn invalid_parameter and invalid_filter_for_kind, the invalid parameter or field.
    invalid_values optionalarray of stringUnknown controlled filter ids.
    discovery optionalstringThe endpoint listing valid filter ids and labels.
    limit optionalstringOnly on rate_limited: which limit you hit. One of: minute, day, month
    retry_after optionalnumberOnly on rate_limited: seconds to wait before retrying.
    reset_at optionalstringOnly on rate_limited: when that limit resets, as an ISO 8601 UTC time.
Request: PUT /v1/collections/{id}/order
curl · Request, PUT /v1/collections/{id}/order
curl -X PUT "https://api.uncommonear.com/v1/collections/example/order" \
  -H "Authorization: Bearer $UNCOMMON_EAR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tracks":["example"]}'
JavaScript · Request, PUT /v1/collections/{id}/order
const url = "https://api.uncommonear.com/v1/collections/example/order";
const response = await fetch(url, {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.UNCOMMON_EAR_API_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({"tracks":["example"]}),
});
const data = await response.json();
console.log(response.status, data);
Python · Request, PUT /v1/collections/{id}/order
import os
import requests

response = requests.put(
    "https://api.uncommonear.com/v1/collections/example/order",
    headers={"Authorization": "Bearer " + os.environ["UNCOMMON_EAR_API_KEY"]},
    json={"tracks": ["example"]},
)
print(response.status_code, response.json())
JSON · 200 response
{
  "id": "example",
  "name": "example",
  "kind": "collection",
  "commercial": true,
  "revision": 1,
  "read_only": true,
  "created": "example",
  "updated": "example",
  "archived_at": "example",
  "description": "example",
  "credits_heading": "example",
  "items": [
    {
      "track": "example",
      "note": "example",
      "added_at": "example",
      "added_by": "example",
      "position": 0,
      "unavailable": true,
      "modifications": {
        "chips": [],
        "text": "example"
      }
    }
  ]
}

Copy only. No request is sent from this page, so your key never goes into a web page. The samples read it from the UNCOMMON_EAR_API_KEY environment variable.