Documents

Get presigned URL for document upload

post/api/v1/documents/upload-url

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/documents/upload-url
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Request body

sandboxboolean

Dashboard mode. API keys always use their authenticated mode.

collectionIdsstring[]

Explicit destination collections. Omission or [] leaves the resource unassigned.

filenamestring required
contentTypestring required
namestring

What to call the document. The filename is restricted to ASCII because it names the stored file; a name is not. Defaults to the filename. Confirm can still rename it.

Example request

{
  "filename": "contract.pdf",
  "contentType": "application/pdf",
  "name": "Lease: Flat 4 (renewal)"
}

Response

documentIdstring required
uploadUrlstring required
keystring required
maxUploadBytesnumber required

Largest file this organization's plan accepts, in bytes. Uploading a bigger file is rejected when the upload is confirmed, so check it before transferring.

Example response

{
  "maxUploadBytes": 26214400
}

Changes

No recorded changes to this operation across all 1 revision of this API.