Pulse upload protocol (2.3)

TUS v1 resumable upload protocol.

• POST creates a new upload. The Upload-Metadata header must include base64-encoded key/value pairs:
  • artifactId (or the legacy videoid/projectid aliases) — a UUID generated by your server.
  • filename — original filename; the extension must match the kind's allowed list.
  • kind — video (default), project, captions, or thumbnail. Determines the storage subdir and which completion hooks fire.
  • relatedTo — optional UUID of another artifact this one belongs to (e.g. the captions, beat manifest or thumbnail belonging to a pulse's video).
  • checksum — optional <algorithm>:<hex digest> of the finished file, verified post-upload if a checksum validator is configured.
• PATCH appends a chunk at the offset given by Upload-Offset, with Content-Type: application/offset+octet-stream.
• HEAD returns the current offset for a resumable upload.
• DELETE removes the upload and its artifact, whether in flight (a cancel) or finished. Authorized as delete.

See https://tus.io/protocols/resumable-upload for the full protocol.

TUS v1 resumable upload protocol.

• POST creates a new upload. The Upload-Metadata header must include base64-encoded key/value pairs:
  • artifactId (or the legacy videoid/projectid aliases) — a UUID generated by your server.
  • filename — original filename; the extension must match the kind's allowed list.
  • kind — video (default), project, captions, or thumbnail. Determines the storage subdir and which completion hooks fire.
  • relatedTo — optional UUID of another artifact this one belongs to (e.g. the captions, beat manifest or thumbnail belonging to a pulse's video).
  • checksum — optional <algorithm>:<hex digest> of the finished file, verified post-upload if a checksum validator is configured.
• PATCH appends a chunk at the offset given by Upload-Offset, with Content-Type: application/offset+octet-stream.
• HEAD returns the current offset for a resumable upload.
• DELETE removes the upload and its artifact, whether in flight (a cancel) or finished. Authorized as delete.

See https://tus.io/protocols/resumable-upload for the full protocol.

TUS v1 resumable upload protocol.

• POST creates a new upload. The Upload-Metadata header must include base64-encoded key/value pairs:
  • artifactId (or the legacy videoid/projectid aliases) — a UUID generated by your server.
  • filename — original filename; the extension must match the kind's allowed list.
  • kind — video (default), project, captions, or thumbnail. Determines the storage subdir and which completion hooks fire.
  • relatedTo — optional UUID of another artifact this one belongs to (e.g. the captions, beat manifest or thumbnail belonging to a pulse's video).
  • checksum — optional <algorithm>:<hex digest> of the finished file, verified post-upload if a checksum validator is configured.
• PATCH appends a chunk at the offset given by Upload-Offset, with Content-Type: application/offset+octet-stream.
• HEAD returns the current offset for a resumable upload.
• DELETE removes the upload and its artifact, whether in flight (a cancel) or finished. Authorized as delete.

See https://tus.io/protocols/resumable-upload for the full protocol.

TUS v1 resumable upload protocol.

• POST creates a new upload. The Upload-Metadata header must include base64-encoded key/value pairs:
  • artifactId (or the legacy videoid/projectid aliases) — a UUID generated by your server.
  • filename — original filename; the extension must match the kind's allowed list.
  • kind — video (default), project, captions, or thumbnail. Determines the storage subdir and which completion hooks fire.
  • relatedTo — optional UUID of another artifact this one belongs to (e.g. the captions, beat manifest or thumbnail belonging to a pulse's video).
  • checksum — optional <algorithm>:<hex digest> of the finished file, verified post-upload if a checksum validator is configured.
• PATCH appends a chunk at the offset given by Upload-Offset, with Content-Type: application/offset+octet-stream.
• HEAD returns the current offset for a resumable upload.
• DELETE removes the upload and its artifact, whether in flight (a cancel) or finished. Authorized as delete.

See https://tus.io/protocols/resumable-upload for the full protocol.

TUS v1 resumable upload protocol.

• POST creates a new upload. The Upload-Metadata header must include base64-encoded key/value pairs:
  • artifactId (or the legacy videoid/projectid aliases) — a UUID generated by your server.
  • filename — original filename; the extension must match the kind's allowed list.
  • kind — video (default), project, captions, or thumbnail. Determines the storage subdir and which completion hooks fire.
  • relatedTo — optional UUID of another artifact this one belongs to (e.g. the captions, beat manifest or thumbnail belonging to a pulse's video).
  • checksum — optional <algorithm>:<hex digest> of the finished file, verified post-upload if a checksum validator is configured.
• PATCH appends a chunk at the offset given by Upload-Offset, with Content-Type: application/offset+octet-stream.
• HEAD returns the current offset for a resumable upload.
• DELETE removes the upload and its artifact, whether in flight (a cancel) or finished. Authorized as delete.

See https://tus.io/protocols/resumable-upload for the full protocol.

TUS v1 resumable upload protocol.

• POST creates a new upload. The Upload-Metadata header must include base64-encoded key/value pairs:
  • artifactId (or the legacy videoid/projectid aliases) — a UUID generated by your server.
  • filename — original filename; the extension must match the kind's allowed list.
  • kind — video (default), project, captions, or thumbnail. Determines the storage subdir and which completion hooks fire.
  • relatedTo — optional UUID of another artifact this one belongs to (e.g. the captions, beat manifest or thumbnail belonging to a pulse's video).
  • checksum — optional <algorithm>:<hex digest> of the finished file, verified post-upload if a checksum validator is configured.
• PATCH appends a chunk at the offset given by Upload-Offset, with Content-Type: application/offset+octet-stream.
• HEAD returns the current offset for a resumable upload.
• DELETE removes the upload and its artifact, whether in flight (a cancel) or finished. Authorized as delete.

See https://tus.io/protocols/resumable-upload for the full protocol.

TUS v1 resumable upload protocol.

• POST creates a new upload. The Upload-Metadata header must include base64-encoded key/value pairs:
  • artifactId (or the legacy videoid/projectid aliases) — a UUID generated by your server.
  • filename — original filename; the extension must match the kind's allowed list.
  • kind — video (default), project, captions, or thumbnail. Determines the storage subdir and which completion hooks fire.
  • relatedTo — optional UUID of another artifact this one belongs to (e.g. the captions, beat manifest or thumbnail belonging to a pulse's video).
  • checksum — optional <algorithm>:<hex digest> of the finished file, verified post-upload if a checksum validator is configured.
• PATCH appends a chunk at the offset given by Upload-Offset, with Content-Type: application/offset+octet-stream.
• HEAD returns the current offset for a resumable upload.
• DELETE removes the upload and its artifact, whether in flight (a cancel) or finished. Authorized as delete.

See https://tus.io/protocols/resumable-upload for the full protocol.

TUS v1 resumable upload protocol.

• POST creates a new upload. The Upload-Metadata header must include base64-encoded key/value pairs:
  • artifactId (or the legacy videoid/projectid aliases) — a UUID generated by your server.
  • filename — original filename; the extension must match the kind's allowed list.
  • kind — video (default), project, captions, or thumbnail. Determines the storage subdir and which completion hooks fire.
  • relatedTo — optional UUID of another artifact this one belongs to (e.g. the captions, beat manifest or thumbnail belonging to a pulse's video).
  • checksum — optional <algorithm>:<hex digest> of the finished file, verified post-upload if a checksum validator is configured.
• PATCH appends a chunk at the offset given by Upload-Offset, with Content-Type: application/offset+octet-stream.
• HEAD returns the current offset for a resumable upload.
• DELETE removes the upload and its artifact, whether in flight (a cancel) or finished. Authorized as delete.

See https://tus.io/protocols/resumable-upload for the full protocol.

TUS v1 resumable upload protocol.

• POST creates a new upload. The Upload-Metadata header must include base64-encoded key/value pairs:
  • artifactId (or the legacy videoid/projectid aliases) — a UUID generated by your server.
  • filename — original filename; the extension must match the kind's allowed list.
  • kind — video (default), project, captions, or thumbnail. Determines the storage subdir and which completion hooks fire.
  • relatedTo — optional UUID of another artifact this one belongs to (e.g. the captions, beat manifest or thumbnail belonging to a pulse's video).
  • checksum — optional <algorithm>:<hex digest> of the finished file, verified post-upload if a checksum validator is configured.
• PATCH appends a chunk at the offset given by Upload-Offset, with Content-Type: application/offset+octet-stream.
• HEAD returns the current offset for a resumable upload.
• DELETE removes the upload and its artifact, whether in flight (a cancel) or finished. Authorized as delete.

See https://tus.io/protocols/resumable-upload for the full protocol.

TUS v1 resumable upload protocol.

• POST creates a new upload. The Upload-Metadata header must include base64-encoded key/value pairs:
  • artifactId (or the legacy videoid/projectid aliases) — a UUID generated by your server.
  • filename — original filename; the extension must match the kind's allowed list.
  • kind — video (default), project, captions, or thumbnail. Determines the storage subdir and which completion hooks fire.
  • relatedTo — optional UUID of another artifact this one belongs to (e.g. the captions, beat manifest or thumbnail belonging to a pulse's video).
  • checksum — optional <algorithm>:<hex digest> of the finished file, verified post-upload if a checksum validator is configured.
• PATCH appends a chunk at the offset given by Upload-Offset, with Content-Type: application/offset+octet-stream.
• HEAD returns the current offset for a resumable upload.
• DELETE removes the upload and its artifact, whether in flight (a cancel) or finished. Authorized as delete.

See https://tus.io/protocols/resumable-upload for the full protocol.

Unauthenticated — the response carries no secrets. Lets a client detect protocol compatibility, allowed artifact kinds/extensions and the upload size cap before pairing.

Deletes all storage for an artifactId (bytes + sidecar metadata), regardless of kind. Runs the authorize hook with phase: "delete" before the adapter's remove is called. Returns 204 on success, 404 if the artifactId was unknown, 501 if the adapter does not implement remove.

Resolves the artifactId through the configured storage adapter and either streams the bytes or redirects (for CDN-backed adapters). The artifact's kind (video, project, or captions) is resolved from storage, not the URL. Runs the authorize hook before resolve.

Returns a token that opens the artifact (and the artifacts relatedTo it) as GET /artifacts/:artifactId?token=, and nothing more — no uploads, deletes or further links. Runs the authorize hook with phase: "share"; the host's issueViewLink decides how long the link works. 404 unless the server enables view links (/capabilities viewLinks) and the artifact is finished; 403 when the host refuses a link for it.

Reports the artifact's state (unknown, uploading, processing while a web-ready conversion rewrites it, ready), its kind and relatedTo, the bytes received against its declared length, whether the host's onUploadComplete has finished (acknowledged), and what the host recorded with recordOutcome (outcome). Runs the authorize hook with phase: "status"; createCapabilityAuthorize grants it to the pairing token and to a view token. Never cached.

Streams or redirects to the finished thumbnail relatedTo the video, exactly as GET /artifacts/:artifactId would serve it. Runs the authorize hook with phase: "resolve" on the video, so whoever may watch it may see its poster. 404 until the poster has landed.