Skip to navigation
Benchling APIAgent

Create or continue a chat with an agent

Beta
Create or continue a chat with an agent

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.
inputlist of objectsRequired
Ordered list of user message blocks.
chatIdstring or nullOptional

Existing chat ID to append to; omit to start a new chat.

connectorsobjectOptional

Connector selection for this request. Omitting this field is equivalent to {“mode”: “none”}. Only available when “agent” and “sources” are omitted.

editingTargetobjectOptional

Benchling object (e.g. entry) to edit via a new chat. Not allowed when “agent” or “chatId” are specified.

sourceslist of objectsOptional

Data sources the agent may use. Not available for benchling_ask_v1.

agentenumOptionalDeprecated
Deprecated agent identifier to use.
Allowed values:

Response

Task started
pollingUristringOptional
taskIdstringOptional

Errors

400
Agent Create Request Bad Request Error
402
Agent Create Request Payment Required Error
403
Agent Create Request Forbidden Error
404
Agent Create Request Not Found Error
429
Agent Create Request Too Many Requests Error
500
Agent Create Request Internal Server Error