Sign in
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 6 of the 110 revisions of this API.310

  • bd7b6ea4a0df1See the full diff
    • ●

      added the new cancelled enum value to the turns/items/state response property for the response status 200

      response-property-enum-value-added

  • 04ee2f39c20a2See the full diff
    • ○

      added the optional property branchMaterialization to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property nativeForkAvailableAfterSequence to the response with the 200 status

      response-required-property-added

  • 67641f18606a2See the full diff
    • ○

      added the optional property turns/items/hasRetryAttempt to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property turns/items/retryOfTurnId to the response with the 200 status

      response-optional-property-added

  • e7b23ab9a07a2See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

      added the new recovered enum value to the turns/items/state response property for the response status 200

      response-property-enum-value-added

  • 2422f8d3eddc5See the full diff
    • ○

      added the optional property activeBranchId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property branchPoints to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property messages/items/content to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property branchedFromEarlierMessage to the response with the 200 status

      response-required-property-added

    • ○

      added the required property messages/items/editAvailable to the response with the 200 status

      response-required-property-added

  • d8396ad2c7211See the full diff
    • ○

      endpoint added

      endpoint-added