Collections | AudioDN Docs

GET /v1/collection

Returns a list of collections for an organization

Parameters

Name	Type	Required	Description
`limit`	number	Optional	Maximum number of collections to return
`offset`	number	Optional	Number of collections to skip

Response

{
  "ok": true,
  "api_request_id": "uuid",
  "count": "number",
  "collections": [ /* Array of collection details */ ]
}

GET /v1/collection/:collection_id

Returns details about a specific collection

Parameters

Name	Type	Required	Description
`collection_id`	uuid	Required	The ID of the collection to retrieve (path parameter)

Response

{
  "ok": true,
  "api_request_id": "uuid",
  "collection_id": "uuid",
  "collection": { /* Collection details */ }
}

POST /v1/collection

Creates a new collection

Parameters

Name	Type	Required	Description
`title`	string	Required	Title of the collection
`creator_id`	uuid	Optional	ID of the creator that owns the collection
`organization_index`	string	Optional	Organization Identifier
`metadata`	object	Optional	Organization metadata for the collection
`theme`	array of strings	Optional	Theme colors (hex values)
`is_cover_overridable`	boolean	Optional	Whether collection cover can be overridden at the track level
`is_theme_overridable`	boolean	Optional	Whether collection theme can be overridden at the track level
`player_color`	string	Optional	Player color (hex color)
`player_subtitle`	string	Optional	Player subtitle

Example Request

{
  "title": "My Collection",
  "metadata": { "description": "A collection of audio tracks" },
  "theme": ["#FF0000", "#00FF00"],
  "player_subtitle": "Artist Name"
}

Response

{
  "ok": true,
  "api_request_id": "uuid",
  "collection_id": "uuid",
  "collection": { /* Collection details */ },
  "collection_cover_upload": {
    "method": "POST",
    "upload_url": "url",
    "ttl": 3600,
    "expires_at": "string"
  }
}

PUT /v1/collection/:collection_id

Updates an existing collection

Parameters

Name	Type	Required	Description
`collection_id`	uuid	Required	The ID of the collection to update (path parameter)
`creator_id`	uuid	Optional	ID of the creator
`organization_index`	string	Optional	Organization Identifier
`title`	string	Optional	Title of the collection
`metadata`	object	Optional	Organization metadata
`theme`	array of strings	Optional	Theme colors (hex values)
`is_cover_overridable`	boolean	Optional	Whether collection cover can be overridden at the track level
`is_theme_overridable`	boolean	Optional	Whether collection theme can be overridden at the track level
`player_color`	string	Optional	Player color (hex color)
`player_subtitle`	string	Optional	Player subtitle

Response

{
  "ok": true,
  "api_request_id": "uuid",
  "collection_id": "uuid",
  "collection": { /* Updated collection */ }
}

DELETE /v1/collection/:collection_id

Deletes a collection

Parameters

Name	Type	Required	Description
`collection_id`	uuid	Required	The ID of the collection to delete (path parameter)

Response

{
  "ok": true,
  "api_request_id": "uuid",
  "collection_id": "uuid",
  "deleted_collection": { /* Deleted collection details */ }
}