Back to Tool Reference
MCP

virtual_model.generate

Generate (or top up) virtual models for one audience.

EffectwritesReachesoutside VaybelScopevirtual_model:writePlanStarter+CreditsmeteredRate limit10/minIdempotent

Generates one model per gender in the audience that doesn't already have a CREATED one — so this is a safe "fill in what's missing" call. Costs 1 credit per model generated (models auto-created when an audience is first saved are free). When everything already exists it's a no-op (task_id empty, no charge).

Parameters

audience_keystringRequired

Audience to generate for (see brand_dna.get).

idempotency_keystring

Send the same key when retrying this exact call. A completed request replays for 24 hours without running or billing again.

callback_urlstring

An https URL that receives a signed completion event when the work finishes, so you can skip polling. See Webhooks.

Returns

handlestring | null

The task id; pass to virtual_model.get_generation. null when nothing needed generating.

audience_keystring
status"pending" | "complete"
credit_unitsint

Models being generated (= credits charged).

virtual_model_idsstring[]

Already-existing model ids (when complete).

messagestring

Describes the virtual_model.get_generation(..., wait_sec=...) contract.

Request
json
{
  "name": "virtual_model.generate",
  "arguments": {
    "audience_key": "women_25_34"
  }
}