Skip to content
OpenBot

files.createUpload

POST
/v1/files/uploads
curl --request POST \
  --url https://example.com/v1/files/uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "filename": "example", "mediaType": "example", "bytes": 1 }'

Makes a pending file and a signed address in object storage. The client puts the bytes there itself, then completes the file. The platform can turn this way off.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
filename
required
string
>= 1 characters <= 255 characters
mediaType
required
string
>= 2 characters <= 255 characters
bytes
required
integer
> 0 <= 9007199254740991

Example generated

{
  "filename": "example",
  "mediaType": "example",
  "bytes": 1
}

Responses

Section titled “Responses”

201

Section titled “201”

Success

Media typeapplication/json
object
file
required
object
id
required
string
>= 1 characters <= 128 characters
object
required
string
Allowed values: file
filename
required
string
mediaType
required
string
bytes
required
integer
<= 9007199254740991
status
required
string
Allowed values: pending ready
createdAt
required
number
url
required
string
method
required
string
Allowed values: PUT
headers
required
object
key
additional properties
string
expiresAt
required
number

Example 

{
  "file": {
    "object": "file",
    "status": "pending"
  },
  "method": "PUT"
}

400

Section titled “400”

FileInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: FileInvalid
message
required
string

Example 

{
  "_tag": "FileInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Forbidden
action
required
string
kind
required
string
field
string
reason
string

Example 

{
  "_tag": "Forbidden"
}

404

Section titled “404”

FileNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: FileNotFound
id
required
string

Example 

{
  "_tag": "FileNotFound"
}

409

Section titled “409”

FilesDisabled | @nmnmcc/ability/Authorizer/Pending

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: FilesDisabled
message
required
string

Example 

{
  "_tag": "FilesDisabled"
}

413

Section titled “413”

FileQuotaExceeded

Media typeapplication/json
object
_tag
required
string
Allowed values: FileQuotaExceeded
message
required
string
quotaBytes
required
integer
<= 9007199254740991
usedBytes
required
integer
<= 9007199254740991

Example 

{
  "_tag": "FileQuotaExceeded"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

FilesUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: FilesUnavailable

Example 

{
  "_tag": "FilesUnavailable"
}