Skip to content

Get Agent Discovery Campaign Brief

GET
/agent/onboarding/discovery/campaign-brief

The campaign brief the record would produce. A PREVIEW - it writes nothing.

Deterministic and LLM-free: running it again after two more answers gives the same document plus two facts, not a differently-worded one. That is what makes it safe to poll while the interview is still going.

It never fills a gap to look finished. open_musts and assumptions come back alongside the copy, because a brief that reads as complete while four must-answer questions are open is how a silent gap becomes a confident wrong campaign.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for an onboarding or discovery result.

Open on purpose. Discovery state carries a per-field coverage matrix whose field set is the product’s own onboarding questionnaire - it changes as the questionnaire does, and a pinned mirror would silently DROP a field the customer had answered. On a surface whose whole job is “what do we still not know about you”, a dropped field reads as an answered question.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string