Skip to navigation
v2Apps

Create an App Canvas

Create an App Canvas that a Benchling App can write to and read user interaction from.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
appIdstringOptional
Identifier of the app owning this canvas. For backwards compatibility, this property will be temporarily optional until the requisite time window for breaking changes in beta endpoints has passed.
blockslist of objectsOptional
datastring or nullOptional
Additional data to associate with the canvas. Can be useful for persisting data associated with the canvas but won't be rendered to the user. If specified, it must be valid JSON in string format less than 5kb in total.
enabledbooleanOptional

Overall control for whether the canvas is interactable or not. If false, every block is disabled and will override the individual block’s enabled property. If true or absent, the interactivity status will defer to the block’s enabled property.

featureIdstringOptional
Identifier of the feature defined in Benchling App Manifest this canvas corresponds to.
resourceIdstringOptional
Identifier of the resource object to attach canvas to.
sessionIdstring or nullOptional
Identifier of a session. If specified, app status messages from the session will be reported in the canvas.

Response

Created
blockslist of objectsOptional
archiveRecordobject or nullOptional
datastring or nullOptional
Additional data to associate with the canvas. Can be useful for persisting data associated with the canvas but won't be rendered to the user. If specified, it must be valid JSON in string format less than 5kb in total.
enabledbooleanOptional

Overall control for whether the canvas is interactable or not. If false, every block is disabled and will override the individual block’s enabled property. If true or absent, the interactivity status will defer to the block’s enabled property.

featureIdstringOptional
Identifier of the feature defined in Benchling App Manifest this canvas corresponds to.
resourceIdstringOptional
Identifier of the resource object to attach canvas to.
sessionIdstring or nullOptional
Identifier of a session. If specified, app status messages from the session will be reported in the canvas.
appobjectOptional
idstringOptional

Errors

400
Bad Request Error
403
Forbidden Error