Guide
Product Files, Public Assets and Package Downloads
Upload private delivery files and public media with the right access checks, and retrieve generated packages through short-lived links.
Delivery files up to 10 GB each
Each private delivery file can be up to 10 GB (10,000,000,000 bytes). Local multipart uploads retry interrupted parts. After a page reload, reselect the same file to reuse completed parts within 24 hours of starting the upload; the browser cannot silently reopen a local file.
Upload history shows the product, progress, and resume deadline. A remote-link import copies the file into private storage; retrying it may restart from the source rather than resume at the same byte. Protected or expired download links need a new direct link.
A file is attached only after its stored object, size, and upload session are checked. Incomplete uploads are not customer downloads. Public artwork and demos remain separate from private delivery files; attaching a file does not publish the product or grant ownership.
SoundSync
Direct upload parts
/api/products/:id/files/direct-uploads
Start or resume a direct upload
- Auth
- Account Bearer session token
- Scope
- Workspace permissions and product assignments are checked.
- Request fields
- filename: string (required)
- sizeBytes: integer (required)
- mimeType: string
- multipart: boolean
- fileFingerprint: string
- Returns
- Job and signed upload instructions; follow the returned mode and part limits.
- Notes
- Use returned upload instructions. Local multipart resume requires reselecting the identical file within the returned deadline; the browser cannot reopen it silently. Current product management verifies workspace permissions and any product ownership/assignment before database writes or AI work. Creating a product or using untargeted new-product AI requires products.create and all-products scope. Existing-product edits/AI use products.edit, file operations use product_files permissions, scheduled-deal writes use marketing.manage, and purchase-option deal publication retains products.publish. Statistics require analytics.view. Publication/archival keep their dedicated permissions. The effective workspace developer owns new products; the teammate remains the audit actor.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"filename": {
"type": "string"
},
"sizeBytes": {
"type": "integer",
"minimum": 1,
"maximum": 10000000000
},
"mimeType": {
"type": "string"
},
"multipart": {
"type": "boolean"
},
"fileFingerprint": {
"type": "string",
"pattern": "^v1:[a-f0-9]{64}$"
}
},
"required": [
"filename",
"sizeBytes"
],
"additionalProperties": true
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"job": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"productId": {
"type": "integer",
"minimum": 1
},
"sourceType": {
"type": "string"
},
"originalFilename": {
"type": "string"
},
"filename": {
"type": "string"
},
"storageKey": {
"type": "string"
},
"fileSizeBytes": {
"type": [
"integer",
"null"
]
},
"mimeType": {
"type": "string"
},
"checksum": {
"type": "string"
},
"status": {
"type": "string"
},
"progress": {
"type": "number"
},
"errorCode": {
"type": "string"
},
"errorMessage": {
"type": "string"
},
"attachedProductFileId": {
"type": [
"string",
"integer"
]
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"expectedSizeBytes": {
"type": [
"integer",
"null"
]
},
"resumable": {
"type": "boolean"
},
"resumeExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"upload": {
"type": "object",
"properties": {
"method": {
"type": "string"
},
"url": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"partSize": {
"type": "integer"
},
"partNumber": {
"type": "integer",
"minimum": 1
},
"parts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partNumber": {
"type": "integer",
"minimum": 1
},
"url": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"expiresIn": {
"type": "integer"
}
},
"additionalProperties": true
},
"processing": {
"type": "boolean"
},
"deduplicated": {
"type": "boolean"
},
"file": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
},
"key": {
"type": "string"
}
},
"additionalProperties": true
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/products/:id/files/direct-uploads/:jobId/parts/:partNumber
Prepare the specified part
- Auth
- Account Bearer session token
- Scope
- Workspace permissions and product assignments are checked.
- Returns
- Temporary PUT instructions for the permitted part.
- Notes
- Current product management verifies workspace permissions and any product ownership/assignment before database writes or AI work. Creating a product or using untargeted new-product AI requires products.create and all-products scope. Existing-product edits/AI use products.edit, file operations use product_files permissions, scheduled-deal writes use marketing.manage, and purchase-option deal publication retains products.publish. Statistics require analytics.view. Publication/archival keep their dedicated permissions. The effective workspace developer owns new products; the teammate remains the audit actor.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"upload": {
"type": "object",
"properties": {
"method": {
"type": "string"
},
"url": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"partSize": {
"type": "integer"
},
"partNumber": {
"type": "integer",
"minimum": 1
},
"parts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partNumber": {
"type": "integer",
"minimum": 1
},
"url": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"expiresIn": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/products/:id/files/direct-uploads/:jobId/part
Prepare a part using JSON
- Auth
- Account Bearer session token
- Scope
- Workspace permissions and product assignments are checked.
- Request fields
- partNumber: integer (required)
- Returns
- Temporary PUT instructions for the permitted part.
- Notes
- Current product management verifies workspace permissions and any product ownership/assignment before database writes or AI work. Creating a product or using untargeted new-product AI requires products.create and all-products scope. Existing-product edits/AI use products.edit, file operations use product_files permissions, scheduled-deal writes use marketing.manage, and purchase-option deal publication retains products.publish. Statistics require analytics.view. Publication/archival keep their dedicated permissions. The effective workspace developer owns new products; the teammate remains the audit actor.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"partNumber": {
"type": "integer",
"minimum": 1
}
},
"required": [
"partNumber"
],
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"upload": {
"type": "object",
"properties": {
"method": {
"type": "string"
},
"url": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"partSize": {
"type": "integer"
},
"partNumber": {
"type": "integer",
"minimum": 1
},
"parts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partNumber": {
"type": "integer",
"minimum": 1
},
"url": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"expiresIn": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
/api/products/:id/files/direct-uploads/:jobId/complete
Verify and attach a stored upload
- Auth
- Account Bearer session token
- Scope
- Workspace permissions and product assignments are checked.
- Request fields
- sizeBytes: integer
- Returns
- Job and attachment result after stored-object/session checks.
- Notes
- Completes only after object/session/size verification. Do not manually attach an unfinished storage key. Current product management verifies workspace permissions and any product ownership/assignment before database writes or AI work. Creating a product or using untargeted new-product AI requires products.create and all-products scope. Existing-product edits/AI use products.edit, file operations use product_files permissions, scheduled-deal writes use marketing.manage, and purchase-option deal publication retains products.publish. Statistics require analytics.view. Publication/archival keep their dedicated permissions. The effective workspace developer owns new products; the teammate remains the audit actor.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"sizeBytes": {
"type": "integer"
}
},
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"job": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"productId": {
"type": "integer",
"minimum": 1
},
"sourceType": {
"type": "string"
},
"originalFilename": {
"type": "string"
},
"filename": {
"type": "string"
},
"storageKey": {
"type": "string"
},
"fileSizeBytes": {
"type": [
"integer",
"null"
]
},
"mimeType": {
"type": "string"
},
"checksum": {
"type": "string"
},
"status": {
"type": "string"
},
"progress": {
"type": "number"
},
"errorCode": {
"type": "string"
},
"errorMessage": {
"type": "string"
},
"attachedProductFileId": {
"type": [
"string",
"integer"
]
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"expectedSizeBytes": {
"type": [
"integer",
"null"
]
},
"resumable": {
"type": "boolean"
},
"resumeExpiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
},
"upload": {
"type": "object",
"properties": {
"method": {
"type": "string"
},
"url": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"partSize": {
"type": "integer"
},
"partNumber": {
"type": "integer",
"minimum": 1
},
"parts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partNumber": {
"type": "integer",
"minimum": 1
},
"url": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"expiresIn": {
"type": "integer"
}
},
"additionalProperties": true
},
"processing": {
"type": "boolean"
},
"deduplicated": {
"type": "boolean"
},
"file": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
},
"key": {
"type": "string"
}
},
"additionalProperties": true
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 500, 503.
Generated HISE and JUCE packages return JSON links
Successful package generation/download preparation returns JSON containing url, filename, and expiresIn, not an archive blob. Fetch the signed URL to retrieve the ZIP; current links expire after 300 seconds. Never log or publish a live signed URL.
A private cached package is matched to its package source, product credentials, and branding. Changing those inputs requires the appropriate regeneration. A busy generator can return 429; missing storage/configuration can return 503. Handle these states rather than saving the JSON response as a ZIP.
SoundSync
Package link response shape (illustrative)
{
"url": "https://storage.example.invalid/signed-package-url",
"filename": "product-package.zip",
"expiresIn": 300
}
SoundSync
Full operation map
SoundSync
HISE package requests
Package Management API
Product status, HISEScript/native generation, rotation, storefront package, and private ZIP links.
SoundSync
Public image, audio and helpful-file uploads
/api/r2/upload-image
Upload a public image asset
- Auth
- Account Bearer session token
- Scope
- Existing product_files.manage, brand.manage, storefront.manage or marketing.manage permission for the selected purpose. Product targets also require ownership and assigned-product access. Brand and storefront assets require all-products workspace scope and reject productId overrides. Other untargeted uploads require all-products scope; a new-product upload also needs products.create.
- Request fields
- query uploadPurpose: string (required)
- query productId: integer. Product or marketing uploads only: an existing product owned by the effective workspace and assigned to this teammate. Required for selected-product uploads. Brand and storefront assets reject this override.
- query workspaceId: integer. Optional active workspace selector; membership is verified by the server.
- file: string (required). One file field. Default byte limit 10485760; configured server limits and type validation remain authoritative.
- Returns
- HTTP 200: url, key, name, public, assetType.
- Notes
- Authentication and scope checks run before multipart buffering and storage. Send purpose and scope in the query, not multipart body fields. Uploading does not save or publish a product, campaign or website. Images/audio/helpful assets are public; paid installers and protected archives must use current private direct-upload APIs. Customers and view-only accounts cannot upload developer assets.
Request, response and error reference
Query and header parameters
[
{
"in": "query",
"name": "uploadPurpose",
"required": true,
"schema": {
"type": "string",
"enum": [
"product",
"brand",
"storefront",
"marketing"
]
}
},
{
"in": "query",
"name": "productId",
"schema": {
"type": "integer",
"minimum": 1
},
"description": "Product or marketing uploads only: an existing product owned by the effective workspace and assigned to this teammate. Required for selected-product uploads. Brand and storefront assets reject this override."
},
{
"in": "query",
"name": "workspaceId",
"schema": {
"type": "integer",
"minimum": 1
},
"description": "Optional active workspace selector; membership is verified by the server."
}
]
Request (multipart/form-data)
{
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "One file field. Default byte limit 10485760; configured server limits and type validation remain authoritative."
}
},
"additionalProperties": true,
"required": [
"file"
]
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"public": {
"type": "boolean"
},
"assetType": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"url",
"key",
"name"
]
}
Documented failures: 400, 401, 403, 404, 413, 415, 500, 503.
Operation errors: UPLOAD_PURPOSE_REQUIRED, UPLOAD_SCOPE_INVALID, INVALID_PRODUCT_ID, PRODUCT_NOT_FOUND, developer_team_permission_denied, developer_team_all_products_scope_required, UPLOAD_TOO_LARGE, UNSUPPORTED_FILE_TYPE.
/api/r2/upload-public-audio
Upload a public audio asset
- Auth
- Account Bearer session token
- Scope
- Existing product_files.manage, brand.manage, storefront.manage or marketing.manage permission for the selected purpose. Product targets also require ownership and assigned-product access. Brand and storefront assets require all-products workspace scope and reject productId overrides. Other untargeted uploads require all-products scope; a new-product upload also needs products.create.
- Request fields
- query uploadPurpose: string (required)
- query productId: integer. Product or marketing uploads only: an existing product owned by the effective workspace and assigned to this teammate. Required for selected-product uploads. Brand and storefront assets reject this override.
- query workspaceId: integer. Optional active workspace selector; membership is verified by the server.
- file: string (required). One file field. Default byte limit 52428800; configured server limits and type validation remain authoritative.
- Returns
- HTTP 200: url, key, name, public, assetType.
- Notes
- Authentication and scope checks run before multipart buffering and storage. Send purpose and scope in the query, not multipart body fields. Uploading does not save or publish a product, campaign or website. Images/audio/helpful assets are public; paid installers and protected archives must use current private direct-upload APIs. Customers and view-only accounts cannot upload developer assets.
Request, response and error reference
Query and header parameters
[
{
"in": "query",
"name": "uploadPurpose",
"required": true,
"schema": {
"type": "string",
"const": "product"
}
},
{
"in": "query",
"name": "productId",
"schema": {
"type": "integer",
"minimum": 1
},
"description": "Product or marketing uploads only: an existing product owned by the effective workspace and assigned to this teammate. Required for selected-product uploads. Brand and storefront assets reject this override."
},
{
"in": "query",
"name": "workspaceId",
"schema": {
"type": "integer",
"minimum": 1
},
"description": "Optional active workspace selector; membership is verified by the server."
}
]
Request (multipart/form-data)
{
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "One file field. Default byte limit 52428800; configured server limits and type validation remain authoritative."
}
},
"additionalProperties": true,
"required": [
"file"
]
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"public": {
"type": "boolean"
},
"assetType": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"url",
"key",
"name"
]
}
Documented failures: 400, 401, 403, 404, 413, 415, 500, 503.
Operation errors: UPLOAD_PURPOSE_REQUIRED, UPLOAD_SCOPE_INVALID, INVALID_PRODUCT_ID, PRODUCT_NOT_FOUND, developer_team_permission_denied, developer_team_all_products_scope_required, UPLOAD_TOO_LARGE, UNSUPPORTED_FILE_TYPE.
/api/r2/upload-public-support-asset
Upload a public support asset
- Auth
- Account Bearer session token
- Scope
- Existing product_files.manage, brand.manage, storefront.manage or marketing.manage permission for the selected purpose. Product targets also require ownership and assigned-product access. Brand and storefront assets require all-products workspace scope and reject productId overrides. Other untargeted uploads require all-products scope; a new-product upload also needs products.create.
- Request fields
- query uploadPurpose: string (required)
- query productId: integer. Product or marketing uploads only: an existing product owned by the effective workspace and assigned to this teammate. Required for selected-product uploads. Brand and storefront assets reject this override.
- query workspaceId: integer. Optional active workspace selector; membership is verified by the server.
- file: string (required). One file field. Default byte limit 26214400; configured server limits and type validation remain authoritative.
- Returns
- HTTP 200: url, key, name, public, assetType.
- Notes
- Authentication and scope checks run before multipart buffering and storage. Send purpose and scope in the query, not multipart body fields. Uploading does not save or publish a product, campaign or website. Images/audio/helpful assets are public; paid installers and protected archives must use current private direct-upload APIs. Customers and view-only accounts cannot upload developer assets.
Request, response and error reference
Query and header parameters
[
{
"in": "query",
"name": "uploadPurpose",
"required": true,
"schema": {
"type": "string",
"const": "product"
}
},
{
"in": "query",
"name": "productId",
"schema": {
"type": "integer",
"minimum": 1
},
"description": "Product or marketing uploads only: an existing product owned by the effective workspace and assigned to this teammate. Required for selected-product uploads. Brand and storefront assets reject this override."
},
{
"in": "query",
"name": "workspaceId",
"schema": {
"type": "integer",
"minimum": 1
},
"description": "Optional active workspace selector; membership is verified by the server."
}
]
Request (multipart/form-data)
{
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "One file field. Default byte limit 26214400; configured server limits and type validation remain authoritative."
}
},
"additionalProperties": true,
"required": [
"file"
]
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"public": {
"type": "boolean"
},
"assetType": {
"type": "string"
}
},
"additionalProperties": true,
"required": [
"url",
"key",
"name"
]
}
Documented failures: 400, 401, 403, 404, 413, 415, 500, 503.
Operation errors: UPLOAD_PURPOSE_REQUIRED, UPLOAD_SCOPE_INVALID, INVALID_PRODUCT_ID, PRODUCT_NOT_FOUND, developer_team_permission_denied, developer_team_all_products_scope_required, UPLOAD_TOO_LARGE, UNSUPPORTED_FILE_TYPE.
Choose public assets or private delivery
Use the multipart public-asset endpoints for product artwork, audio demos and helpful public files. Supply uploadPurpose and any productId or workspaceId as query parameters so authorization runs before the file is buffered. The dashboard supplies this context automatically. File bytes belong in one multipart file field; do not send JSON in its place.
Default per-file limits are 10 MiB for images, 50 MiB for public audio and 25 MiB for helpful support assets; configured limits and supported MIME/extension checks still apply. Uploading a file does not save or publish the surrounding product, website or campaign.
The old generic POST /api/r2/upload and buffered /api/r2/upload-file paths return 410 DIRECT_R2_UPLOAD_REQUIRED. Use current private direct uploads for paid product files and protected archives; never publish their originals as public assets.
Remote imports verify the connection destination
Current and compatibility remote-file importers reject private and reserved addresses, pin the validated address for the connection and revalidate redirect destinations. Website discovery and marketplace media use the same public-network boundary. This does not change upload permissions, accepted file types or private delivery authorization.
Handle an unavailable private file without bypassing verification
PRODUCT_FILE_NOT_VERIFIED (409) means the managed object is missing or unverified. PRODUCT_FILE_NOT_ACCESSIBLE (403) means the verified file is not authorized for the selected workspace/source-product scope. Upload and verify your own file; do not retry using another developer's storage key. The same rules cover legacy direct attachments and newly added version-file references.
