Sign in

v3

latestOpenAPI 3.0.32026-07-21354289.5 KB
File

uploadFilePublic

Create a pre-signed S3 URL for uploading a file without authentication.

No authentication required. This endpoint is intended for public-facing forms and journeys where end-users need to upload files without logging in.

The uploaded file is stored temporarily (one week). Use saveFileV2 with proper authentication to store the file permanently.

Security note: Files uploaded via this endpoint are temporary and require authenticated access to be saved permanently.

post/v1/files/public/upload

Request body

filenamestring required
mime_typestring

MIME type of file

index_tagstring

Used to index the file at the storage layer, which helps when browsing for this file

metadataobject

Allows passing in custom metadata for the file, expects key-value pairs of string type

Example request

{
  "filename": "document.pdf",
  "mime_type": "application/pdf",
  "index_tag": "2f6a377c8e78",
  "metadata": {
    "color": "blue"
  }
}

Response

Pre-signed URL for uploading the file

upload_urlstring url

Pre-signed URL for uploading the file via PUT request

errorstring

Error message if the upload preparation failed

Example response

{
  "s3ref": {
    "bucket": "epilot-prod-user-content",
    "key": "123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
  },
  "upload_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123",
  "error": "File entity not found"
}