Interface StartCreativeWorkflowParams

interface StartCreativeWorkflowParams {
    appSource?: string;
    attribution?: WorkloadAttributionInput;
    billingMode?: BillingMode;
    confirmCost?: boolean;
    idempotencyKey?: string;
    input?: StartCreativeWorkflowInput;
    inputs?: Record<string, unknown>;
    maxEstimatedCapacityUnits?: number;
    mediaReferences?: unknown[];
    tokenType?: TokenType;
    workflowId?: string;
}

Properties

appSource? attribution? billingMode? confirmCost? idempotencyKey? input? inputs? maxEstimatedCapacityUnits? mediaReferences? tokenType? workflowId?

Properties

OptionalappSource

appSource?: string

Optional source label for attribution. Defaults to the client appSource when configured.

Optionalattribution

attribution?: WorkloadAttributionInput

Optional workload attribution overriding this client's defaults.

OptionalbillingMode

billingMode?: BillingMode

Billing mode for workflows. 'subscription' requests subscription entitlement billing, 'tokens' forces token billing, and 'auto' lets the server decide.

OptionalconfirmCost

confirmCost?: boolean

OptionalidempotencyKey

idempotencyKey?: string

Optionalinput

input?: StartCreativeWorkflowInput

Inline workflow definition. Use this for one-shot plans composed client-side (e.g. the output of the compose_workflow chat tool). Mutually exclusive with workflowId.

Optionalinputs

inputs?: Record<string, unknown>

Inputs for the saved template referenced by workflowId. The api resolves these against the template's declared inputs[].

OptionalmaxEstimatedCapacityUnits

maxEstimatedCapacityUnits?: number

OptionalmediaReferences

mediaReferences?: unknown[]

Durable workflows require uploaded HTTP(S) URLs, not inline data URIs.

OptionaltokenType

tokenType?: TokenType

OptionalworkflowId

workflowId?: string

Run a saved workflow template by id. Combine with inputs to pass the concrete user-supplied values (brief, aspect_ratio, etc.). Mutually exclusive with input.

Settings

Member Visibility

On This Page

Properties