BEbenchling
App Session

Create AppSession

Create AppSession.

post/api/v3/app-session

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Headers

EARLY-ACCESSstring

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

Request body

appIdstring required

API ID of the Benchling App that owns this session.

namestring required

Human-readable name for this session.

timeoutSecondsinteger required

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

Response

Created

__typenamestring
createdAtstring datetime
idstring
modifiedAtstring datetime
namestring
status'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'COMPLETED_WITH_WARNINGS' | 'TIMEOUT'

The current lifecycle status of this session, derived from the most recent version.

timeoutSecondsinteger

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.

Changes

No recorded changes to this operation across all 2 revisions of this API.