API Referenceconversations

Create a conversation bound to an active runtime

View as Markdown
Create an agent conversation bound to an active runtime.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Headers

BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Request

This endpoint expects an object.
runtimeIdstringRequired
Unique runtime identifier generated by BCTRL.
modelstringOptional
titlestringOptional1-200 characters
toolsetIdstringOptional
Unique toolset identifier generated by BCTRL.

Response

Created
activeTurnIdstring or null
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
idstring
Unique conversation identifier generated by BCTRL.
modelstring
runtimeIdstring
Unique runtime identifier generated by BCTRL.
statusenum
titlestring or null
toolsetIdstring or null
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error