Create Upload URL | sync. labs

Request a presigned URL to upload a local file. PUT the file bytes to the returned uploadUrl with the same Content-Type, then register the file as an asset via POST /v2/assets using the returned url. Single uploads are capped at 5GB.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

fileNamestringRequired

The name of the file to upload.

contentTypestringRequired

The MIME content type of the file (e.g. video/mp4).

sizeintegerRequired

The size of the file in bytes. Single uploads are capped at 5GB.

Response

Presigned upload URL created successfully

uploadUrlstring

The presigned S3 URL to PUT the file bytes to (with the same Content-Type).

urlstring

The final public URL of the file. Register it as an asset via POST /v2/assets once the upload completes.

expiresIninteger

Seconds until the presigned uploadUrl expires.

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X POST https://api.sync.so/v2/assets/upload \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"fileName": "my-video.mp4",
>	"contentType": "video/mp4",
>	"size": 10485760
>	}'