Skip to main content
GET
Read an action

Authorizations

Authorization
string
header
required

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

Path Parameters

actionId
string<uuid>
required
Example:

"0b6f2c1e-6d2a-4c3e-9a1f-5e8d7c4b3a21"

Response

The action.

id
string<uuid>
required
kind
enum<string>
required

What the work is: new_page (publish a page; Jam can draft it), page_edit (change a page on your site; Jam can prepare the code change), technical (a technical fix on your site; Jam can prepare the code change), outreach (pitch a third-party list or page; your agent does it from agentPrompt), community (take part in a community thread; your agent does it).

Available options:
page_edit,
new_page,
outreach,
technical,
community
problem
enum<string>
required

The gap the action closes.

Available options:
list_absent,
list_low_rank,
wrong_claim,
page_read_rival_won,
missing_page,
technical_defect,
engine_gap,
community_absent,
unclear_positioning,
other
title
string
required
why
string
required
impact
enum<string>
required
Available options:
high,
medium,
low
rank
integer
required

Priority within the Plan; 1 is first.

targetUrl
string | null
required
status
enum<string>
required

The action's status, derived from its history: suggested: Research recommends it and nobody has acted on it yet. in_progress: Someone started it (POST .../start), or Jam is doing it (a draft or a code change is being prepared). sent: Outreach only: the pitch went out (reported by the customer or their agent, never sent by Jam). Waiting for the third party to act. done: Reported done, or Jam shipped it. Jam checks the page once; until that check passes the action stays done. verified: Jam's check found the change on the page (or the brand on the list). unverified: Jam's check did not find the change on the page. Fix it and POST .../checks to check again, or POST .../completion with the right URL. dismissed: Taken off the Plan by the customer. DELETE .../dismissal puts it back. superseded: A later research run no longer proposes it (the gap closed or another action replaced it). Hidden from the list unless includeSuperseded=true.

Available options:
suggested,
in_progress,
sent,
done,
verified,
unverified,
dismissed,
superseded
opportunityId
string<uuid> | null
required

The article opportunity (/v1/opportunities/{id}) behind a new_page action, once Jam has one. Null otherwise.

lastSeenAt
string<date-time>
required
kindLabel
string
required
source
enum<string>
required

research: proposed by research. planner: an article row the planner added.

Available options:
research,
planner
details
string[]
required

The evidence and specifics research found.

sources
string[]
required

Pages research read for this action.

questions
object[]
required

The tracked prompts this action should move.

history
object[]
required

Everything that happened to the action, oldest first.

check
object | null
required

Jam's latest one-time check of a done claim.

agentPrompt
string
required

Executable instructions for your agent: the work, written by research, ending with how to report it done through this API (POST /v1/actions/{id}/completion, or /sent for an outreach pitch).

change
object | null
required

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

firstSeenAt
string<date-time>
required