Skip to main content
GET
Read the research state

Authorizations

Authorization
string
header
required

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

Response

The research state.

state
enum<string>
required
Available options:
never,
running,
done,
failed
startedAt
string<date-time> | null
required
finishedAt
string<date-time> | null
required
latest
object | null
required
inFlight
object | null
required

The run in flight, if any. Runs take about ten minutes.

manual
object
required

Research again, by hand.

automaticTopUp
object
required

Jam's free automatic re-run: at most once a week, after a successful run, once a scan has new answers, and only while the Plan has fewer than 5 untouched article rows. notBefore is when the weekly limit next allows one.