Run a Blueprint
Execute a blueprint by providing input values. Returns a run ID you can poll for progress.
POST
/api/v1/blueprints/{blueprintId}/runsPath Parameters
blueprintId -- The ID of the blueprint to run.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| inputs | array | No | Array of input overrides. Each entry has stepReferenceId, targetField, and value |
| variationPrompt | string | No | Natural-language variation instruction (max 5000 characters) |
| variationLlm | string | No | LLM model to use for variation generation |
| skipMissingTextInputs | boolean | No | Skip blueprint steps that have missing text inputs instead of failing |
| skipMissingMediaInputs | boolean | No | Skip blueprint steps that have missing media inputs instead of failing |
Input Entry Shape
| Parameter | Type | Required | Description |
|---|---|---|---|
| stepReferenceId | string | Yes | The referenceId from the metadata response |
| targetField | string | Yes | Which field to override (e.g. prompt, mediaId) |
| value | string | Yes | The value to set for this input |
Response
{
"runId": "run_..."
}Example
POST
/api/v1/blueprints/{blueprintId}/runs{
"inputs": [
{
"stepReferenceId": "step_abc",
"targetField": "prompt",
"value": "A sleek product shot on marble"
},
{
"stepReferenceId": "step_def",
"targetField": "mediaId",
"value": "media_img_123"
}
],
"variationPrompt": "Make it more dramatic with darker lighting",
"skipMissingTextInputs": true
}