Skip to main content
GET
Where the organization stands with setup

Authorizations

Authorization
string
header
required

Your secret key (pep_sk_…) from Settings → API. Keys are org-scoped; treat them like passwords.

Response

The readiness reading.

object
string
required
Allowed value: "onboarding"
stage
enum<string>
required
Available options:
choosing_path,
open,
pre_flow,
handoff_pending,
completed,
skipped
handoff
object
required
agent
object | null
required
live
boolean
required
verified
boolean
required
go_live_blockers
string[]
required
checklist
object
required

The setup checklist (items, done, total, complete).

journey
object
required
queues
object
required

What awaits triage.

credits
object
required
smoke_test
object
required
path
enum<string> | null
Available options:
ui,
ai,
skipped,
null
source
object | null

The primary onboarding source (website or document), when one exists.

extraction
object | null
activity
object

What is running now, one reading for every surface: live, stage (reading | extracting | summarizing | reading_again | drafting | idle), headline, detail, kinds (live run kinds), labels.

receipts
integer

Curation receipts recorded so far.

thread
object | null

The assistant's open thread, when one exists.