Upload Private File

API endpoint for uploading private files. Uploaded files are kept private so that only users with access to the specified environment can retrieve them. The endpoint validates the survey ID, file name, and file type from the request body, and returns a signed URL for S3 uploads along with a local upload URL.

Authorizations

x-api-key

string

header

required

Use your Formbricks x-api-key to authenticate.

Path Parameters

environmentId

string

required

The ID of the environment.

Body

application/json

surveyId

string

required

The ID of the survey associated with the file.

fileName

string

required

The name of the file to be uploaded.

fileType

string

required

The MIME type of the file.

Response

200

application/json

OK - Returns the signed URL, signing data, updated file name, and file URL.

data

object

Show child attributes

data.signedUrl

string

Signed URL for uploading the file to local storage.

data.signingData

object

Show child attributes

data.signingData.signature

string

Signature for verifying the upload.

data.signingData.timestamp

number

Timestamp used in the signature.

data.signingData.uuid

string

Unique identifier for the signed upload.

data.updatedFileName

string

The updated file name after processing.

data.fileUrl

string

URL where the uploaded file can be accessed.