files.uploadFile

POST

/v1/files

const url = 'https://example.com/v1/files';
const form = new FormData();
form.append('file', 'file');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file=@file

Uploads one file through OpenBot, as multipart/form-data with the field file. The file is ready at once. The platform can turn this way off.

Authorizations

token
session

Request Body^required

multipart/form-data

object

file

required

string format: binary

Responses

201

Success

application/json

object

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

Example

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

400

FileInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: FileInvalid

message

required

string

Example

{
  "_tag": "FileInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

FileNotFound

application/json

object

_tag

required

string

Allowed values: FileNotFound

required

string

Example

{
  "_tag": "FileNotFound"
}

409

FilesDisabled | @nmnmcc/ability/Authorizer/Pending

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: FilesDisabled

message

required

string

Example

{
  "_tag": "FilesDisabled"
}

413

FileQuotaExceeded

application/json

object

_tag

required

string

Allowed values: FileQuotaExceeded

message

required

string

quotaBytes

required

integer

<= 9007199254740991

usedBytes

required

integer

<= 9007199254740991

Example

{
  "_tag": "FileQuotaExceeded"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

FilesUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: FilesUnavailable

Example

{
  "_tag": "FilesUnavailable"
}

files.uploadFile

Authorizations

Request Bodyrequired

Responses

201

Example

400

Example

401

Example

403

Example

404

Example

409

Example

413

Example

429

Example

503

Example

Request Body^required