Skip to main content
POST
Run Generation

Authorizations

Authorization
string
header
required

Aspect API key (sk_...) in Authorization header. 'Bearer ' optional.

Path Parameters

attribute_id
string<uuid>
required

Attribute ID

Query Parameters

dry_run
boolean
default:false

Return the counts without starting the run; not supported when target.kind is assets

Body

application/json

API request schema for a run: what it does and which assets it covers.

mode
enum<string>
required

fill runs only the assets not run yet (or whose last run failed); overwrite re-runs every asset, replacing the AI's answers; answers entered by hand are kept unless replace_manual is true

Available options:
fill,
overwrite
target
WatchRunTarget · object
required

Every asset the column watches; rejected when it watches nothing.

replace_manual
boolean
default:false

With overwrite, also replace answers entered by hand. Ignored by fill

Response

Successful Response

API response schema for an explicit run's counts.

count
integer
required

Number of assets the run covers (with dry_run, the number it would cover)

manually_entered
integer | null

How many assets of the target currently hold an answer entered by hand. Only returned for overwrite dry runs; count leaves them out unless replace_manual is true