Get session
Retrieve a session by ID.
GET
/api/session/{sessionID}Path parameters
sessionIDobjectrequiredResponses
200Success
dataSession.InforequiredShow propertiesHide properties
idobjectrequiredShow propertiesHide properties
objectparentIDobjectShow propertiesHide properties
objectforkobjectShow propertiesHide properties
sessionIDobjectrequiredShow propertiesHide properties
objectmessageIDobjectShow propertiesHide properties
objectprojectIDstringrequiredagentstringmodelModel.RefShow propertiesHide properties
idstringrequiredproviderIDstringrequiredvariantstringcostMoney.USDrequiredtokensTokenUsage.InforequiredShow propertiesHide properties
inputnumberrequiredoutputnumberrequiredreasoningnumberrequiredcacheobjectrequiredShow propertiesHide properties
readnumberrequiredwritenumberrequiredtimeobjectrequiredShow propertiesHide properties
creatednumberrequiredupdatednumberrequiredarchivednumbertitlestringrequiredlocationLocation.RefrequiredShow propertiesHide properties
directorystringrequiredworkspaceIDobjectShow propertiesHide properties
objectsubpathstringrevertSession.RevertShow propertiesHide properties
messageIDobjectrequiredShow propertiesHide properties
objectpartIDstringsnapshotstringfilesFileDiff.Info[]Show propertiesHide properties
Array of
FileDiff.InfofilestringrequiredpatchstringrequiredadditionsobjectrequiredShow propertiesHide properties
objectdeletionsobjectrequiredShow propertiesHide properties
objectstatusstringrequiredAllowed:
addeddeletedmodified400InvalidRequestError
_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:
SessionNotFoundErrorsessionIDstringrequiredmessagestringrequiredRequest
curl -X GET "/api/session/%5Bobject%20Object%5D"const response = await fetch("/api/session/%5Bobject%20Object%5D", {
method: "GET"
});import requests
response = requests.get(
"/api/session/%5Bobject%20Object%5D",
)Response
{
"data": {
"id": {},
"parentID": {},
"fork": {
"sessionID": {},
"messageID": {}
},
"projectID": "string",
"agent": "string",
"model": {
"id": "string",
"providerID": "string",
"variant": "string"
},
"cost": 0,
"tokens": {
"input": 0,
"output": 0,
"reasoning": 0,
"cache": {
"read": 0,
"write": 0
}
},
"time": {
"created": 0,
"updated": 0,
"archived": 0
},
"title": "string",
"location": {
"directory": "string",
"workspaceID": {}
},
"subpath": "string",
"revert": {
"messageID": {},
"partID": "string",
"snapshot": "string",
"files": [
{
"file": "string",
"patch": "string",
"additions": {},
"deletions": {},
"status": "added"
}
]
}
}
}{
"_tag": "InvalidRequestError",
"message": "string",
"kind": "string",
"field": "string"
}{
"_tag": "UnauthorizedError",
"message": "string"
}{
"_tag": "SessionNotFoundError",
"sessionID": "string",
"message": "string"
}