SpecifyDocs

File library upload begin

/v1/library/uploads

Signed-in sessionLaunch key product.filesOperation file_library_upload_begin

People and agents upload files, link them to tasks, memories and briefings, preview them, and run processing jobs on them.

Body

folderIdstring
expectedAuthorizationVersionstring
targetEntityType"briefing" | "document" | "memory" | "task"
targetEntityIdstring
mimestringRequired
sha256stringRequired
idempotencyKeystringRequired
filenamestringRequired
sizeBytesnumberRequired

Returns

idstringRequired
fileIdstringRequired
phase"available" | "blocked" | "canceled" | "canceling" | "reserved" | "transferring" | "verifying"Required
retryablebooleanRequired
expiresAtnumberRequired

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.