Skip to content

createDocumentUploadUrl

WRITE

Create a presigned upload URL for a document in the "private" bucket.

POST /api/v1/documents/createDocumentUploadUrl
curl -X POST '<your-host>/api/v1/documents/createDocumentUploadUrl' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "folder": "string",
    "entityId": "string",
    "name": "string"
  }'
Response
{
  "signedUrl": "string",
  "token": "string",
  "path": "string"
}

Parameters

ParameterType

Input schema

schema
{
  "type": "object",
  "properties": {
    "folder": {
      "type": "string"
    },
    "entityId": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "folder",
    "entityId",
    "name"
  ]
}