Skip to main content
POST
Start a Brief's Run

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>
required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Idempotency-Key
string<uuid>

UUID. A retry with the same key replays the first result instead of starting the work again.

Path Parameters

id
string<uuid>
required

Brief id

Body

application/json
duplicateResolutions
object[]

How to handle a market that already has a live Article for this Brief: overwrite rewrites that Article in place, new_version writes a separate Article

Maximum array length: 50

Response

Run queued. Location points at the Run

data
object
required
poll
string
required

/api/v1/jobs/{jobId}