Skip to main content
PATCH
/
api
/
sessions
/
{sessionId}
Update session
curl --request PATCH \
  --url https://api.recoupable.dev/api/sessions/{sessionId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "linesAdded": 1,
  "linesRemoved": 1
}
'
{
  "session": {
    "id": "<string>",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "isNewBranch": true,
    "globalSkillRefs": [
      {}
    ],
    "lifecycleVersion": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "artistId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "repoOwner": "<string>",
    "repoName": "<string>",
    "branch": "<string>",
    "cloneUrl": "<string>",
    "sandboxState": {},
    "lastActivityAt": "2023-11-07T05:31:56Z",
    "sandboxExpiresAt": "2023-11-07T05:31:56Z",
    "hibernateAfter": "2023-11-07T05:31:56Z",
    "lifecycleRunId": "<string>",
    "lifecycleError": "<string>",
    "linesAdded": 123,
    "linesRemoved": 123,
    "snapshotUrl": "<string>",
    "snapshotCreatedAt": "2023-11-07T05:31:56Z",
    "snapshotSizeBytes": 123,
    "cachedDiff": {},
    "cachedDiffUpdatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
sessionId
string
required

The id of the session to update.

Body

application/json

All fields are optional; an empty object {} is valid and leaves the session unchanged.

​
title
string

New display title for the session (rename).

​
status
enum<string>

Lifecycle status (matches the DB CHECK). running is active / unarchived; completed and failed are terminal; archived archives the row. Use running to unarchive from archived.

Available options:
running,
completed,
failed,
archived
​
linesAdded
integer

Updates the persisted lines_added column on the session (≥ 0).

Required range: x >= 0
​
linesRemoved
integer

Updates the persisted lines_removed column on the session (≥ 0).

Required range: x >= 0

Response

Session updated successfully.

​
session
object
required

Agent session returned by POST /api/sessions, GET /api/sessions/{sessionId}, and PATCH /api/sessions/{sessionId}. The api serializes every field listed in required on each response, including isNewBranch (boolean, from the non-null sessions.is_new_branch column) and artistId (UUID or null).