PATCH/user/files/chunked-upload/{id}

Upload a chunk to a resumable file upload

Uploads a binary chunk to an existing resumable user file upload, or sends the entire file in one chunk. Set Upload-Offset to the server's current byte offset and send the chunk as application/offset+octet-stream. If the offset conflicts, check the upload status with HEAD and retry from the returned offset.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 parameters
idstringrequired
The unique identifier generated by the server when the upload was created.
Tus-Resumablestringrequired
The Tus protocol version. Must be `1.0.0`.
Allowed:1.0.0
Upload-Offsetintegerrequired
The byte offset at which this chunk starts. Must match the current offset on the server.
Content-Typestringrequired
The media type of the chunk. Must be `application/offset+octet-stream`.
Allowed:application/offset+octet-stream
Content-Lengthintegerrequired
The size of the chunk in bytes.

4 status codes
204Returns no response body and confirms that the chunk was accepted.
404Returned when the upload ID is invalid.
409Returned when the `Upload-Offset` header does not match the current server offset.
415Returned when the `Content-Type` header is not `application/offset+octet-stream`.

Error handling

A 404 is returned when the id path parameter does not identify a valid upload. A 409 is returned when the Upload-Offset header does not match the server's current offset; retrieve the current offset with the status-check HEAD request before retrying. A 415 is returned unless the Content-Type header is application/offset+octet-stream; the Tus-Resumable header must be 1.0.0.