POST v1/Upload-Session/Abort

POST

https://api.subworkflow.ai/v1/upload-session/abort

Aborts an existing Multipart Upload Session.

Summary

• Please ensure you've read this upload sessions readme.md before continuing.
• Once aborted, any chunks uploaded for the upload session are deleted.

Parameters

name	type	location	required	description
content-type	string	header	required	You must set the request content type to multipart/form-data
key	string	body	required	The identifier for the upload session. This is obtained from the initial /start request.

Responses

Success

{
    "type": "object",
    "properties": {
        "success": { "type": "boolean" },
    }
}

400 Error

{
    "success": { "type": "boolean" },
    "error": { "type": "string" }
}

404 Error

{
    "success": { "type": "boolean" },
    "error": { "type": "string" }
}

Example

Curl

curl -X POST https://api.subworkfow.ai/v1/upload-session/abort \
    --header 'x-api-key: <YOUR-API-KEY>' \
    --header 'Content-Type: multipart/form-data' \
    --form "key=tmp_xMX0GRh5Ifa3VrY7"

JS/TS

const formdata = new FormData();
formdata.append("key", "tmp_xMX0GRh5Ifa3VrY7");

const req = await fetch("https://api.subworkflow.ai/v1/upload-session/abort", {
    method: "POST",
    headers: {
        "Content-Type": "multipart/form-data",
        "x-api-key": "<YOUR-API-KEY>"
    },
    body: formdata,
});

{
    "success": true
}