/files

POST {{base-api-url}}/files

It is highly recommended to specify the .pdf extension at the end of your file name. So, when you will download your file, it will directly contain the extension and then, it will be easier to open it on your computer.

The content of a file must be converted in base64 encoding, without the base64 header. Before send it to the API, you need to check and eventually remove the header data:application/pdf;base64,.

Request Body

{"name"=>"The best name for my file.pdf", "content"=>"JVBERi0xLjUKJb/3ov4KNiA [...] VPRgo="}

HEADERS

KeyDatatypeRequiredDescription
AuthorizationstringThis value is a secret and needs to be replaced by your API Key (Bearer).
Content-TypestringThis header specifies the format of the exchanges in JSON.

RESPONSES

status: Created

{"id":"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"The best name for my file.pdf","type":"signable","contentType":"application/pdf","description":null,"createdAt":"2018-12-01T11:36:20+01:00","updatedAt":"2018-12-01T11:36:20+01:00","sha256":"bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2","metadata":[],"workspace":"/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","creator":null,"protected":false,"position":0,"parent":null}