Skip to main content
POST
Open the session analyst for a session

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Path Parameters

session_id
string<uuid>
required

Session id (UUID) as returned by startSession or listSessions.

Body

application/json

Optional request body of openSessionAnalyst. An empty body returns the caller's conversation with the tree, if any; question asks (starting the conversation if needed); reset ends the current conversation.

question
string

A question for the analyst. Starts the caller's conversation with this tree when there is none, as its first turn; otherwise it is delivered to the existing conversation. An analyst is never started without one.

reset
boolean

When true, ends the caller's current conversation with this tree: the analyst session is cancelled and stays readable, and the caller has no conversation until the next question.

Response

Response body of openSessionAnalyst: the caller's read-only analyst session over a session tree, if there is one, and whether it was just started.

Response body of openSessionAnalyst: the caller's read-only analyst session over a session tree, if there is one, and whether it was just started.

created
boolean
required

True when this call started the analyst; false when it returned the caller's existing conversation with this tree, or none.

session
object

The analyst session, when the caller has a conversation with this tree. Send questions to it with sendSessionEvents and read answers from its events; its kind is session_analyst and its access policy platform_internal. Absent when nothing has been asked yet, or the conversation was just reset: a question starts one.

Example: