SpecifyDocs

design.startPreviewUpload

tools/call

Start the upload of one preview or inspection layer for a revision: send its bytes to the Files upload returned, then name its fileId in design.registerRevision before the time its result names.

Scopes

read:designupload:design_previews

No other scope applies. The preview is stored in Files without a link target, so the target scopes (read:projects, write:projects, read:memory, contribute:memory, curate:memory, read:agent_sessions and document scopes) are never checked. Only you see it until a revision you register uses it.

Inputs

idempotencyKeystringRequired
componentIdstringRequired
namestringRequired
contentType"image/png"Required
sizeBytesintegerRequired
sha256stringRequired
widthintegerRequired
heightintegerRequired

Returns

The Design operation's result. A call returns content[0].text with the JSON result and structuredContent.result with the same value.

Listed when

The key has Design access and the tool's scope.