Document Creation

Prerequisites

Before you can upload a file to Petal, you will need:

Your bearer token and desired Workspace ID. They can be obtained as described here.
Software that can use APIs, such as cURL or Python.

Upload a Document

The API endpoint for creating a Document is https://cite.petal.org/api/document/create. You will need to send a POST request to the endpoint with a multipart/form-data body containing three fields:

integer

The ID of your Workspace/Organization

string

The extension of your document, e.g. pdf, docx, ppt

binary

The file you wish to upload

Below is an example of a Document creation POST request.

Remember to replace <token> with your own bearer token.

curl --location --request POST 'https://cite.petal.org/api/document/create' \
--header 'Authorization: Bearer <token>' \
--form 'doctype="xls"' \
--form 'organization_id="1"' \
--form 'file=@"/your/filepath/here/sample.xls"'

import requests

url = "https://cite.petal.org/api/document/create"

payload={'doctype': 'xls', 'organization_id': '1'}
files=[
  ('file',('sample.xls',open('/your/filepath/here/sample.xls','rb'),'application/vnd.ms-excel'))
]
headers = {'Authorization': 'Bearer <token>'}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

var form = new FormData();
form.append("doctype", "xls");
form.append("organization_id", "1");
form.append("file", fileInput.files[0], "sample.xls");

var settings = {
  "url": "https://cite.petal.org/api/document/create",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer <token>"
  },
  "processData": false,
  "mimeType": "multipart/form-data",
  "contentType": false,
  "data": form
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

Get Started

Sample Use Cases

Prerequisites

Upload a Document