Get session messages
Retrieve projected messages for a session. Items keep the requested order across pages; use cursor.next or cursor.previous to move through the ordered timeline.
GET
/api/session/{sessionID}/messagePath parameters
sessionIDobjectrequiredQuery parameters
limitstring | anyorderstring | anycursorstring | anyResponses
200SessionMessagesResponse
dataSession.Message.Info[]requiredShow propertiesHide properties
Array of
Session.Message.InfoAny of:
Session.Message.AgentSelected
idobjectrequiredShow propertiesHide properties
objectmetadataobjecttimeobjectrequiredShow propertiesHide properties
creatednumberrequiredtypestringrequiredAllowed:
agent-switchedagentstringrequiredSession.Message.ModelSelected
idobjectrequiredShow propertiesHide properties
objectmetadataobjecttimeobjectrequiredShow propertiesHide properties
creatednumberrequiredtypestringrequiredAllowed:
model-switchedmodelModel.RefrequiredShow propertiesHide properties
idstringrequiredproviderIDstringrequiredvariantstringpreviousModel.RefShow propertiesHide properties
idstringrequiredproviderIDstringrequiredvariantstringSession.Message.User
idobjectrequiredShow propertiesHide properties
objectmetadataobjecttimeobjectrequiredShow propertiesHide properties
creatednumberrequiredtextstringrequiredfilesPrompt.FileAttachment[]Show propertiesHide properties
Array of
Prompt.FileAttachmentdataPrompt.Base64requiredShow propertiesHide properties
objectmimestringrequiredsourcePrompt.FileSourcerequiredShow propertiesHide properties
Any of:
object
typestringrequiredAllowed:
inlineobject
typestringrequiredAllowed:
uriuristringrequirednamestringdescriptionstringmentionPrompt.MentionShow propertiesHide properties
startnumberrequiredendnumberrequiredtextstringrequiredagentsPrompt.AgentAttachment[]Show propertiesHide properties
Array of
Prompt.AgentAttachmentnamestringrequiredmentionPrompt.MentionShow propertiesHide properties
startnumberrequiredendnumberrequiredtextstringrequiredtypestringrequiredAllowed:
userSession.Message.Synthetic
idobjectrequiredShow propertiesHide properties
objectmetadataobjecttimeobjectrequiredShow propertiesHide properties
creatednumberrequiredtextstringrequireddescriptionstringtypestringrequiredAllowed:
syntheticSession.Message.System
idobjectrequiredShow propertiesHide properties
objectmetadataobjecttimeobjectrequiredShow propertiesHide properties
creatednumberrequiredtypestringrequiredAllowed:
systemtextstringrequiredSession.Message.Skill
idobjectrequiredShow propertiesHide properties
objectmetadataobjecttimeobjectrequiredShow propertiesHide properties
creatednumberrequiredtypestringrequiredAllowed:
skillskillstringrequirednamestringrequiredtextstringrequiredSession.Message.Shell
idobjectrequiredShow propertiesHide properties
objectmetadataobjecttimeobjectrequiredShow propertiesHide properties
creatednumberrequiredcompletednumbertypestringrequiredAllowed:
shellshellIDobjectrequiredShow propertiesHide properties
objectcommandstringrequiredstatusstringrequiredAllowed:
runningexitedtimeoutkilledexitnumber | string | stringShow propertiesHide properties
Any of:
number | string
Any of:
number
numberstring
stringstring
stringstring
stringstring
stringoutputobjectShow propertiesHide properties
outputstringrequiredcursorobjectrequiredShow propertiesHide properties
objectsizeobjectrequiredShow propertiesHide properties
objecttruncatedbooleanrequiredSession.Message.Assistant
idobjectrequiredShow propertiesHide properties
objectmetadataobjecttimeobjectrequiredShow propertiesHide properties
creatednumberrequiredcompletednumbertypestringrequiredAllowed:
assistantagentstringrequiredmodelModel.RefrequiredShow propertiesHide properties
idstringrequiredproviderIDstringrequiredvariantstringcontentSession.Message.Assistant.Text | Session.Message.Assistant.Reasoning | Session.Message.Assistant.Tool[]requiredShow propertiesHide properties
Array of
Session.Message.Assistant.Text | Session.Message.Assistant.Reasoning | Session.Message.Assistant.ToolAny of:
Session.Message.Assistant.Text
typestringrequiredAllowed:
texttextstringrequiredSession.Message.Assistant.Reasoning
typestringrequiredAllowed:
reasoningtextstringrequiredstateSession.Message.ProviderStatetimeobjectShow propertiesHide properties
creatednumberrequiredcompletednumberSession.Message.Assistant.Tool
typestringrequiredAllowed:
toolidstringrequirednamestringrequiredexecutedbooleanproviderStateSession.Message.ProviderStateproviderResultStateSession.Message.ProviderStatestateSession.Message.ToolState.Streaming | Session.Message.ToolState.Running | Session.Message.ToolState.Completed | Session.Message.ToolState.ErrorrequiredShow propertiesHide properties
Any of:
Session.Message.ToolState.Streaming
statusstringrequiredAllowed:
streaminginputstringrequiredSession.Message.ToolState.Running
statusstringrequiredAllowed:
runninginputobjectrequiredstructuredobjectrequiredcontentLLM.ToolContent[]requiredShow propertiesHide properties
Array of
LLM.ToolContentAny of:
Tool.TextContent
typestringrequiredAllowed:
texttextstringrequiredTool.FileContent
typestringrequiredAllowed:
fileuristringrequiredmimestringrequirednamestringSession.Message.ToolState.Completed
statusstringrequiredAllowed:
completedinputobjectrequiredcontentLLM.ToolContent[]requiredShow propertiesHide properties
Array of
LLM.ToolContentAny of:
Tool.TextContent
typestringrequiredAllowed:
texttextstringrequiredTool.FileContent
typestringrequiredAllowed:
fileuristringrequiredmimestringrequirednamestringstructuredobjectrequiredresultanySession.Message.ToolState.Error
statusstringrequiredAllowed:
errorinputobjectrequiredcontentLLM.ToolContent[]requiredShow propertiesHide properties
Array of
LLM.ToolContentAny of:
Tool.TextContent
typestringrequiredAllowed:
texttextstringrequiredTool.FileContent
typestringrequiredAllowed:
fileuristringrequiredmimestringrequirednamestringstructuredobjectrequirederrorSession.StructuredErrorrequiredShow propertiesHide properties
typestringrequiredmessagestringrequiredresultanytimeobjectrequiredShow propertiesHide properties
creatednumberrequiredrannumbercompletednumbersnapshotobjectShow propertiesHide properties
startstringendstringfilesstring[]finishstringAllowed:
stoplengthtool-callscontent-filtererrorunknowncostMoney.USDtokensTokenUsage.InfoShow propertiesHide properties
inputnumberrequiredoutputnumberrequiredreasoningnumberrequiredcacheobjectrequiredShow propertiesHide properties
readnumberrequiredwritenumberrequirederrorSession.StructuredErrorShow propertiesHide properties
typestringrequiredmessagestringrequiredretrySession.Message.Assistant.RetryShow propertiesHide properties
attemptobjectrequiredShow propertiesHide properties
objectatnumberrequirederrorSession.StructuredErrorrequiredShow propertiesHide properties
typestringrequiredmessagestringrequiredSession.Message.Compaction
Any of:
Session.Message.Compaction.Running
typestringrequiredAllowed:
compactionidobjectrequiredShow propertiesHide properties
objectmetadataobjecttimeobjectrequiredShow propertiesHide properties
creatednumberrequiredstatusstringrequiredAllowed:
runningreasonstringrequiredAllowed:
automanualsummarystringrequiredrecentstringrequiredSession.Message.Compaction.Completed
typestringrequiredAllowed:
compactionidobjectrequiredShow propertiesHide properties
objectmetadataobjecttimeobjectrequiredShow propertiesHide properties
creatednumberrequiredstatusstringrequiredAllowed:
completedreasonstringrequiredAllowed:
automanualsummarystringrequiredrecentstringrequiredSession.Message.Compaction.Failed
typestringrequiredAllowed:
compactionidobjectrequiredShow propertiesHide properties
objectmetadataobjecttimeobjectrequiredShow propertiesHide properties
creatednumberrequiredstatusstringrequiredAllowed:
failedreasonstringrequiredAllowed:
automanualerrorSession.StructuredErrorrequiredShow propertiesHide properties
typestringrequiredmessagestringrequiredcursorobjectrequiredShow propertiesHide properties
previousstring | anyShow propertiesHide properties
Any of:
string
stringany
anynextstring | anyShow propertiesHide properties
Any of:
string
stringany
any400InvalidCursorError | InvalidRequestError
Any of:
InvalidCursorError
_tagstringrequiredAllowed:
InvalidCursorErrormessagestringrequiredInvalidRequestError
_tagstringrequiredAllowed:
InvalidRequestErrormessagestringrequiredkindstring | anyShow propertiesHide properties
Any of:
string
stringany
anyfieldstring | anyShow propertiesHide properties
Any of:
string
stringany
any401UnauthorizedError
_tagstringrequiredAllowed:
UnauthorizedErrormessagestringrequired404SessionNotFoundError
Any of:
SessionNotFoundError
_tagstringrequiredAllowed:
SessionNotFoundErrorsessionIDstringrequiredmessagestringrequiredSessionNotFoundError
_tagstringrequiredAllowed:
SessionNotFoundErrorsessionIDstringrequiredmessagestringrequired500UnknownError
_tagstringrequiredAllowed:
UnknownErrormessagestringrequiredrefstring | anyShow propertiesHide properties
Any of:
string
stringany
anyRequest
curl -X GET "/api/session/%5Bobject%20Object%5D/message"const response = await fetch("/api/session/%5Bobject%20Object%5D/message", {
method: "GET"
});import requests
response = requests.get(
"/api/session/%5Bobject%20Object%5D/message",
)Response
{
"data": [
{
"id": {},
"metadata": {},
"time": {
"created": 0
},
"type": "agent-switched",
"agent": "string"
}
],
"cursor": {
"previous": "string",
"next": "string"
}
}{
"_tag": "InvalidCursorError",
"message": "string"
}{
"_tag": "UnauthorizedError",
"message": "string"
}{
"_tag": "SessionNotFoundError",
"sessionID": "string",
"message": "string"
}{
"_tag": "UnknownError",
"message": "string",
"ref": "string"
}