Skip to main content
POST
Create the trial workspace

Authorizations

Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.

Body

application/json
draftId
string

The draft_… id. Optional on every onboarding route: defaults to the onboarding's current draft.

Required string length: 1 - 64
Example:

"draft_k3v9x0q2m1"

selections
object

Sonar: what the person kept. Omitted = the proposal's defaults.

keywords
object[]

The raw keywords: the classic engine, or a Sonar onboarding whose proposal failed or timed out (send them with no draftId and no selections).

Maximum array length: 20
ifRevision
string

Refuse with 409 ONBOARDING_REVISION_CHANGED unless the state is still at this revision.

Required string length: 1 - 128

Response

200 response

alreadyApplied
boolean
required

True when this onboarding's trial already existed (idempotent re-run).

pendingReview
boolean
required
trial
object
required
state
object
required