headless lms
Assets

Confirm an upload you started

POST /api/member/uploads/{id}/finalize. Confirm an upload you started. Headless LMS Assets API reference.

POST
/api/member/uploads/{id}/finalize

Uploader only; anyone else gets 404. Reads the stored size and content type. A file that is not an image or is over the size limit is discarded and answered with 409. A finalized file moves where the upload URL no longer reaches; finalizing it again returns it unchanged.

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/member/uploads/string/finalize"
{  "orgId": "string",  "id": "string",  "kind": "image",  "source": "library",  "filename": "string",  "contentType": "string",  "size": 0,  "status": "pending",  "uploadedBy": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "url": "string",  "downloadUrl": "string"}
{  "error": "string",  "message": "string",  "requestId": "string",  "issues": [    {      "path": "string",      "message": "string"    }  ]}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}

Register an image you are about to upload and get a presigned upload URL POST

POST /api/member/uploads. Register an image you are about to upload and get a presigned upload URL. Headless LMS Assets API reference.

Delete an upload of yours that nothing references DELETE

DELETE /api/member/uploads/{id}. Delete an upload of yours that nothing references. Headless LMS Assets API reference.