pinakes/docs/api/collections.md

Collections

Media collections

Endpoints

GET /api/v1/collections

Authentication: Required (Bearer JWT)

Responses

Status	Description
200	List of collections
401	Unauthorized
500	Internal server error

---

POST /api/v1/collections

Authentication: Required (Bearer JWT)

Request Body

Content-Type: application/json

See docs/api/openapi.json for the full schema.

Responses

Status	Description
200	Collection created
400	Bad request
401	Unauthorized
403	Forbidden
500	Internal server error

---

GET /api/v1/collections/{id}

Authentication: Required (Bearer JWT)

Parameters

Name	In	Required	Description
id	path	Yes	Collection ID

Responses

Status	Description
200	Collection
401	Unauthorized
404	Not found
500	Internal server error

---

DELETE /api/v1/collections/{id}

Authentication: Required (Bearer JWT)

Parameters

Name	In	Required	Description
id	path	Yes	Collection ID

Responses

Status	Description
200	Collection deleted
401	Unauthorized
403	Forbidden
404	Not found
500	Internal server error

---

GET /api/v1/collections/{id}/members

Authentication: Required (Bearer JWT)

Parameters

Name	In	Required	Description
id	path	Yes	Collection ID

Responses

Status	Description
200	Collection members
401	Unauthorized
404	Not found
500	Internal server error

---

POST /api/v1/collections/{id}/members

Authentication: Required (Bearer JWT)

Parameters

Name	In	Required	Description
id	path	Yes	Collection ID

Request Body

Content-Type: application/json

See docs/api/openapi.json for the full schema.

Responses

Status	Description
200	Member added
401	Unauthorized
403	Forbidden
404	Not found
500	Internal server error

---

DELETE /api/v1/collections/{id}/members/{media_id}

Authentication: Required (Bearer JWT)

Parameters

Name	In	Required	Description
id	path	Yes	Collection ID
media_id	path	Yes	Media item ID

Responses

Status	Description
200	Member removed
401	Unauthorized
403	Forbidden
404	Not found
500	Internal server error

---