Skip to navigation
Benchling APIApp Session

Create AppSession

Beta
Create AppSession.

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 session.
namestringRequired

Human-readable name for this session.

timeoutSecondsintegerRequired

Maximum session duration in seconds before automatic timeout (1 to 2592000).

messageslist of objectsOptional
Initial messages to display. If omitted, the session starts with no messages.

Response

Created
__typenamestringOptional
appobjectOptional
The Benchling App installation that owns this session.
createdAtstringOptional
idstringOptional
messageslist of objectsOptional
The messages currently displayed to the user, from the most recent session version.
modifiedAtstringOptional
namestringOptional
statusenumOptional
The current lifecycle status of this session, derived from the most recent version.
Allowed values:
timeoutSecondsintegerOptional
Maximum duration in seconds before the session times out automatically. Once the session's age exceeds this value and the session has not been finalized, its status becomes TIMEOUT.

Errors

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