Reserve a document and return a presigned upload URL

POST /documents/upload-init

Reserve a document and return a presigned upload URL

cURL

curl --request POST \
  --url https://api.pineyard.ai/documents/upload-init \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "fileSize": 26214400
}
'

200

{
  "documentId": "<string>",
  "uploadUrl": "<string>",
  "uploadUrlExpiresAt": "<string>"
}

Required scope: knowledge.edit

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Body

application/json

name · string · required

Required string length: 1 - 200

fileSize · integer · required

Required range: 1 <= x <= 52428800

mimeType · enum<string> · required

Available options: application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plain, text/markdown

description · string

Maximum string length: 500

Response

200

application/json

OK

documentId · string · required

uploadUrl · string · required

uploadUrlExpiresAt · string · required