Skip to main content
POST
Propose variations

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string
required

Required stable id for this request; reuse it after a timeout to receive the same answer.

Required string length: 1 - 255

Path Parameters

projectId
string
required

The project id.

Required string length: 1 - 200

Body

application/json
referenceAssetId
string
required

The broken-down reference whose breakdown is the Format (break a reference down first with a Sigma turn or the web app).

Required string length: 1 - 200
count
integer
required

How many variants (1-1000); capped at the distinct combinations of the axes.

Required range: 1 <= x <= 1000
axes
object
required

The values to vary, one list per axis; give at least one. Each variant takes one value from every listed axis.

maker
enum<string>

What each variant is: script (the default).

Available options:
script
threadId
string

Continue this Sigma conversation instead of starting one.

Required string length: 1 - 200

Response

Success.

success
boolean
required
threadId
string
required

The Sigma conversation the proposal is recorded in.

messageId
string
required
projectId
string | null
required

Where it runs; null for a workspace conversation until it is approved.

approval
object
required
{key}
any