Skip to navigation
Benchling APIApp Canvas

Create AppCanvas

Beta
Create AppCanvas.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Request

This endpoint expects an object.
appIdstringRequired
API ID of the Benchling App that owns this canvas.
blockslist of objectsRequired
UI blocks defining the canvas layout and interactivity.
featureIdstringRequired
Feature ID from the app manifest that this canvas corresponds to.
resourceIdstringRequired
Identifier of the resource object to attach the canvas to.
datastringOptional

Optional JSON string (max 5 KiB) of app-managed data not rendered in the canvas UI.

enabledbooleanOptional
Whether the canvas is interactable. When false, all blocks are disabled regardless of their individual enabled settings.
sessionIdstringOptional
Optional app session ID whose status messages are shown in the canvas.

Response

Created
__typenamestringOptional
appobjectOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
blockslist of objectsOptional
createdAtstringOptional
datastring or nullOptional
enabledbooleanOptional
featureIdstring or nullOptional
idstringOptional
modifiedAtstringOptional
resourceIdstringOptional
sessionIdstring or nullOptional

Errors

400
App Canvas Create Request Bad Request Error
403
App Canvas Create Request Forbidden Error
404
App Canvas Create Request Not Found Error
409
App Canvas Create Request Conflict Error
429
App Canvas Create Request Too Many Requests Error
500
App Canvas Create Request Internal Server Error