v1

latestOpenAPI 3.0.32026-08-061810496.7 KB

Upload

Request file upload session

Returns the temporary S3 credentials and the storage location (key) required for the upload. If a naming conflict is detected, the conflicting File object is returned.

Usage:

Pass the credentials to the S3 SDK constructor.
Use the returned key property to set the destination path on S3.
Keep the version string for step 3.

<aside class="info">Credentials expire after 60 minutes.</aside>

get/api/2/upload/{fileable}

Query parameters

sizeinteger required

The size of the file in bytes

namestring required

Name of the file including its extension

Example:RL-1.pdf

Name of the file including its extension

conflict_behaviour'replace' | 'rename' | 'fail' nullable

When a file name conflict is detected, this parameter handles its behaviour

Example:replace

When a file name conflict is detected, this parameter handles its behaviour

Response

conflicted_fileablestring nullable

Example response

{
  "data": {
    "id": 2137449171,
    "key": "docs_finals/2137449171/Crooks LLC.sse",
    "name": "Crooks LLC.sse",
    "version": "eyJpdiI6ImpJZTJnQkxnUTZuSlNVdEhIK1d2NkE9PSIsInZhbHVlIjoiNzZiS2J4RFpVWGF6dndwL1ZPdUgzZUVCdGt4ckUrM3d6TDVWKzRnK3hyak5kZk9KWUx0VWx4aFhKOGxNd3lBTU9XYUE2UmVnRkltSEgvdWJZZnViMUlYd3A5VndaWEk4WGxkbDN6eWpVS1dtN2VFb2RwdFRjR3JvaTBpVTlNWmJBczBzMFIwRjliRDJjVzVkZHUxVjdTYld3V01TYzRGZ0V2RjRhSGhCMUNTdDcyZm84bUZtS2tBc1ZqaXF2dVNwMHR0QlRqY1pYOHR4TW5jNDMwQnZoN1kxWmtpOGc3WnhhYThaZC9MZGhNREZHajg2dmpRdW0xdi9iOEtHcTNwWVNDWkhFS0NoQ2dmcFo2Tml3ZDkrdmc5M1p3WjMxV01rOUUrem1MQ0hjVXo1dGxLZ0RvOEVwcXJwK2lwNnlRTDQ5eVBnUUJoMzNzNkd5bWIwdHRDcWpOam5ibDRVaENtaGdCRkdaZkRCMFpxZnB1Q3J3SFQ2L0NzWHJ6VUJlVENCQ2RxNGdpTUFFdm11bnphUDk5NFZxajR5bWdFMXMyTSsvQ1pUM0tKZWI4QmdzclVwVS8wVklIaWZsOU9nTVloMk9lYjBvbWVnR1YrSVRVNmJjbXBnY1B6Q09QRVdCaFc4YWcrS2YwbWpSTFh1cnAzUFJuZXN1dkh4Ry9wcnhqOXZka2RkTDdZTTIrZ2VtUHlpemlWUWFsK2p1d2JDV0R2ekcweTdhS000amZjeEhsd2NrczVXbktmeU9CMVZ5SkZCaCtheFdNbHBpUjJaaXdsWnd0ZTBqakdxRktpMlJyeWZVdTkrY01hdjRoY09UOFlKbDZlSmtiNHRla3VLbUxsN0FlMmQ2aXRUdnhyeHRCL1YzOXBjNWlTdWdSd08zZFZhOVUrWVNxNzNleHlkYzMxeDRReGk2Z05YYXkrOWY1blIiLCJtYWMiOiI0NWRiNWMwMzg0NGQ2NDU3Zjg5ZDFhNjk1NGRmMmE2OWE5NmU5MDhkYmEwM2QwZWI4NjVhODZiM2Q1ODc3NTdhIiwidGFnIjoiIn0=",
    "conflict_behaviour": "fail"
  },
  "credentials": {
    "sessionToken": "...",
    "accessKeyId": "...",
    "secretAccessKey": "...",
    "region": "...",
    "bucket": "..."
  },
  "conflicted_fileable": null
}