createFile

POST

/v5/books/{bookId}/files

Create a file

Parameters

Path Parameters

bookId

required

string

The id of the book. Same bookId url param on Bkper

Request Body

object

agentId

The id of agent that created the resource

string

content

The file content Base64 encoded

string

contentType

The file content type

string

createdAt

The creation timestamp, in milliseconds

string

id

The unique id that identifies the file in the book

string

name

The file name

string

properties

The key/value custom properties of the File

object

key

additional properties

string

size

The file size in bytes

integer format: int64

updatedAt

The last update timestamp, in milliseconds

string

url

The file serving url

string

Example

{
  "agentId": "string",
  "content": "string",
  "contentType": "string",
  "createdAt": "1592000000000",
  "id": "string",
  "name": "string",
  "properties": {
    "key": "value"
  },
  "size": 1,
  "updatedAt": "1592000000000",
  "url": "string"
}

Responses

200

A File response

object

agentId

The id of agent that created the resource

string

content

The file content Base64 encoded

string

contentType

The file content type

string

createdAt

The creation timestamp, in milliseconds

string

id

The unique id that identifies the file in the book

string

name

The file name

string

properties

The key/value custom properties of the File

object

key

additional properties

string

size

The file size in bytes

integer format: int64

updatedAt

The last update timestamp, in milliseconds

string

url

The file serving url

string

Example

{
  "agentId": "string",
  "content": "string",
  "contentType": "string",
  "createdAt": "1592000000000",
  "id": "string",
  "name": "string",
  "properties": {
    "key": "value"
  },
  "size": 1,
  "updatedAt": "1592000000000",
  "url": "string"
}