sessions

Read one saved version of an artifact file

Changed on
get/api/v1/sessions/{sessionId}/artifact-versions/{version}

Request

  • Base URL
    http://127.0.0.1:3001
  • URL
    http://127.0.0.1:3001/api/v1/sessions/{sessionId}/artifact-versions/{version}
  • Auth
    none declared

Path parameters

sessionIdstring required

Session identifier, e.g. project-1.

versioninteger required

Version number within the file's history.

Query parameters

pathstring

Artifact-directory-relative file path, as listed in the session's artifactFiles.

Response

OK

contentstring required

The version's UTF-8 text content, cut short when truncated is set.

createdAtstring date-time required
fileFingerprintstring required

Hex SHA-256 of the version's content.

harnessstring

Best effort: the agent that was running the session when the version was recorded, which after an agent switch can differ from the agent that wrote it. Absent for older versions.

pathstring required
restoredFrominteger

The version this one restored, when it is a restore.

sizeinteger required
source'agent' | 'user' required

Who wrote the version: the agent, or the user through a save or restore.

truncatedboolean

The content is only the first 256 KiB of the version. A restore still writes the whole version.

versioninteger required

Changes

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      endpoint added