Sign in

v3

latestOpenAPI 3.0.32026-07-21354289.5 KB
File

uploadFileV2

Create pre-signed S3 URL to upload a file to keep temporarily (one week).

Use the saveFileV2 operation to store file file permanently.

post/v2/files/upload

Query parameters

string

Empty string (used when file ID not yet assigned)

OR
string uuid

Valid UUID v4

Use this parameter when uploading a file directly to an existing file entity.

Note: still requires calling saveFileV2 to save the file permanently.

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 POST / PUT upload

upload_urlstring url
public_urlstring url

Returned only if file is permanent i.e. file_entity_id is passed

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",
  "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
}
All 35 operations