conversations

Read a chat session's durable conversation

get/api/v1/sessions/{sessionId}/conversation

Path parameters

sessionIdstring required

Session identifier, e.g. project-1.

Session identifier, e.g. project-1.

Query parameters

beforeSequenceinteger nullable

Read items older than this conversation sequence. Omit for the newest page.

Read items older than this conversation sequence. Omit for the newest page.

limitinteger nullable

Maximum combined messages and activities to return. Defaults to 200.

Maximum combined messages and activities to return. Defaults to 200.

Response

OK

activeBranchIdstring
branchedFromEarlierMessageboolean required
capabilitiesstring[]
compactedAtstring nullable
controller'connecting' | 'ready' | 'busy' | 'recovering' | 'stopped' required
conversationIdstring required
harnessstring
hasMoreBeforeboolean required
latestSequenceinteger required
mode'chat' | 'tui' required
nativeForkAvailableAfterSequenceinteger required
oldestSequenceinteger
sessionIdstring required
titlestring

Changes

Changed in 7 of the 169 revisions of this API.314

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ●

      added the new cancelled enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ●

      added the new recovered enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new recovered enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      endpoint added

      endpoint-added