Run a Blueprint

Execute a blueprint by providing input values. Returns a run ID you can poll for progress.


POST/api/v1/blueprints/{blueprintId}/runs

Path Parameters

blueprintId -- The ID of the blueprint to run.

Request Body

ParameterTypeRequiredDescription
inputsarrayNoArray of input overrides. Each entry has stepReferenceId, targetField, and value
variationPromptstringNoNatural-language variation instruction (max 5000 characters)
variationLlmstringNoLLM model to use for variation generation
skipMissingTextInputsbooleanNoSkip blueprint steps that have missing text inputs instead of failing
skipMissingMediaInputsbooleanNoSkip blueprint steps that have missing media inputs instead of failing

Input Entry Shape

ParameterTypeRequiredDescription
stepReferenceIdstringYesThe referenceId from the metadata response
targetFieldstringYesWhich field to override (e.g. prompt, mediaId)
valuestringYesThe 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
}