Sign in
sessions

Read one session workspace file and its git diff

get/api/v1/sessions/{sessionId}/workspace/file

Path parameters

sessionIdstring required

Session identifier, e.g. project-1.

Session identifier, e.g. project-1.

Query parameters

pathstring

Session-worktree-relative file path.

Session-worktree-relative file path.

section'committed' | 'staged' | 'unstaged' | 'untracked'

Git-state section the file was opened from (see WorkspaceFileSections). staged diffs the index against HEAD; unstaged diffs the worktree against the index; omitted/committed/untracked diff the worktree against the compare base.

Git-state section the file was opened from (see WorkspaceFileSections). staged diffs the index against HEAD; unstaged diffs the worktree against the index; omitted/committed/untracked diff the worktree against the compare base.

Response

OK

additionsinteger required
binaryboolean required
compareBaseRefstring
compareBaseShastring
compareMode'base' | 'head_fallback'
contentstring required
contentTruncatedboolean required
deletedboolean required
deletionsinteger required
diffstring required
diffTruncatedboolean required
imageMediaTypestring
pathstring required
previousPathstring
sessionIdstring required
sizeinteger required
status'unmodified' | 'modified' | 'added' | 'deleted' | 'renamed' required

Changes

Changed in 5 of the 117 revisions of this API.11

  • d31a2d019c474See the full diff
    • ○

      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

  • 14fb9cddd7ab1See the full diff
    • ○

      added the new optional query request parameter section

      new-optional-request-parameter

  • 7d395fb305221See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 0d1e03674bc24See the full diff
    • ○

      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

  • afa8f1f796c21See the full diff
    • ○

      endpoint added

      endpoint-added