Skip to content

Ratify Agent Discovery

POST
/agent/onboarding/discovery/ratify

Correct what the agent inferred. The customer’s word wins over the scrape.

edits overrides a value; confirmed accepts one as read. Both default to empty, so ratifying nothing is a legal no-op rather than a 422 - which is what makes the call safe to retry.

The response echoes PROGRESS, not the field list: fields comes back empty by design because the caller already holds it from GET /discovery.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirror of DiscoveryRatifyRequest.

Both collections default to empty, matching the app: ratifying nothing is a legal no-op rather than a 422, which is what makes the call safe to retry.

object
confirmed

Field keys the customer accepts as the agent inferred them.

Array<string>
edits

Field key -> corrected value, for answers the agent got wrong.

object
key
additional properties
any
session_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