Skip to main content
GET
Read a site change

Authorizations

Authorization
string
header
required

A workspace API key issued in Settings → Developer, sent as Bearer sk_….

Path Parameters

changeId
string<uuid>
required
Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

Response

object | null

The change.

The latest code change Jam prepared for this action (page edits and technical fixes), with its preview. Null when none.

id
string<uuid>
required
actionId
string<uuid>
required
status
enum<string>
required

preparing: Jam is finding the file and writing the edit. proposed: ready; read hunks, then open the pull request or discard it. opening: the pull request is being opened. in_review: the pull request is open (prUrl). merged / closed: what happened to it. failed: Jam could not make it (failureMessage). stale: the file changed since; prepare it again. discarded: dropped.

Available options:
preparing,
proposed,
opening,
in_review,
merged,
closed,
failed,
stale,
discarded
repository
string
required

owner/name.

baseBranch
string
required
filePath
string | null
required
createsFile
boolean
required
summary
string | null
required
prUrl
string | null
required
prNumber
integer | null
required
failureMessage
string | null
required
fallback
enum<string> | null
required

copy_prompt when Jam could not make or keep this change: hand the action's agentPrompt to your agent instead.

Available options:
copy_prompt,
null
hunks
object[]
required

The before/after preview as unified diff hunks.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required