Class CreativeWorkflowsApi

Hierarchy (View Summary)

ApiGroup
- CreativeWorkflowsApi

Index

Constructors

constructor

new CreativeWorkflowsApi(config: ApiConfig): CreativeWorkflowsApi
Parameters
- config: ApiConfig
Returns CreativeWorkflowsApi
Overrides ApiGroup.constructor
- Defined in CreativeWorkflows/index.ts:145

Properties

`Protected`client

client: ApiClient

`Protected`eip712

eip712: EIP712Helper

`Protected`listeners

listeners: {} = {}

templates

templates: CreativeWorkflowTemplatesApi

Workflow template CRUD + fork (/v1/creative-agent/workflows/templates). Templates are the savable blueprints behind workflow runs.

Methods

cancel

cancel(workflowId: string): Promise<CreativeWorkflowRecord>
Parameters
- workflowId: string
Returns Promise<CreativeWorkflowRecord>
- Defined in CreativeWorkflows/index.ts:301

`Protected`emit

emit<T extends never>(event: T, data: {}[T]): void
Dispatch an event to all listeners
Type Parameters
- T extends never
Parameters
- event: T
- data: {}[T]
Returns void
Inherited from ApiGroup.emit
- Defined in lib/TypedEventEmitter.ts:69

events

events(workflowId: string): Promise<CreativeWorkflowEvent[]>
Parameters
- workflowId: string
Returns Promise<CreativeWorkflowEvent[]>
- Defined in CreativeWorkflows/index.ts:294

get

get(workflowId: string): Promise<CreativeWorkflowRecord>
Parameters
- workflowId: string
Returns Promise<CreativeWorkflowRecord>
- Defined in CreativeWorkflows/index.ts:287

list

list(options?: ListCreativeWorkflowOptions): Promise<CreativeWorkflowRecord[]>
Parameters
- options: ListCreativeWorkflowOptions = {}
Returns Promise<CreativeWorkflowRecord[]>
- Defined in CreativeWorkflows/index.ts:277

off

off<T extends never>(event: T, listener: (data: {}[T]) => void): void
Remove an event listener
Type Parameters
- T extends never
Parameters
- event: T
- listener: (data: {}[T]) => void
Returns void
Inherited from ApiGroup.off
- Defined in lib/TypedEventEmitter.ts:45

on

on<T extends never>(event: T, listener: (data: {}[T]) => void): () => void
Add an event listener, returns a function that can be called to remove the listener
Type Parameters
- T extends never
Parameters
- event: T
- listener: (data: {}[T]) => void
Returns () => void
Inherited from ApiGroup.on
- Defined in lib/TypedEventEmitter.ts:17

once

once<T extends never>(event: T, listener: (data: {}[T]) => void): () => void
Add an event listener that will be called only once
Type Parameters
- T extends never
Parameters
- event: T
- listener: (data: {}[T]) => void
Returns () => void
Inherited from ApiGroup.once
- Defined in lib/TypedEventEmitter.ts:32

removeAllListeners

removeAllListeners<T extends never>(event?: T): void
Remove all event listeners, optionally for a specific event
Type Parameters
- T extends never
Parameters
- Optionalevent: T
Returns void
Inherited from ApiGroup.removeAllListeners
- Defined in lib/TypedEventEmitter.ts:56

reseed

reseed(
    workflowId: string,
    params?: ReseedCreativeWorkflowParams,
    options?: ReseedCreativeWorkflowOptions,
): Promise<ReseedCreativeWorkflowResult>
Clone a completed (or partial-failure) workflow with fresh seeds. Per-step seed overrides are sent via seedOverrides; any step not listed receives a new random seed. Returns the new workflow record plus the clonedFromRunId so callers can correlate the two runs.
Parameters
- workflowId: string
- params: ReseedCreativeWorkflowParams = {}
- options: ReseedCreativeWorkflowOptions = {}
Returns Promise<ReseedCreativeWorkflowResult>
- Defined in CreativeWorkflows/index.ts:241

resume

resume(
    workflowId: string,
    params?: ResumeCreativeWorkflowParams,
    options?: ResumeCreativeWorkflowOptions,
): Promise<ResumeCreativeWorkflowResult>
Resume a durable workflow that paused in waiting_for_user. The api has already received the user's interactive content through whatever upstream chat path the durable step was waiting on; this call is the "kick the executor back into motion" knob. Returns the workflow record at resume time plus a resumed: true flag.
Parameters
- workflowId: string
- params: ResumeCreativeWorkflowParams = {}
- options: ResumeCreativeWorkflowOptions = {}
Returns Promise<ResumeCreativeWorkflowResult>
- Defined in CreativeWorkflows/index.ts:210

start

start(
params: StartCreativeWorkflowParams,
options?: StartCreativeWorkflowOptions,
): Promise<CreativeWorkflowRecord>
Parameters
- params: StartCreativeWorkflowParams
- options: StartCreativeWorkflowOptions = {}
Returns Promise<CreativeWorkflowRecord>
- Defined in CreativeWorkflows/index.ts:150

streamEvents

streamEvents(
workflowId: string,
options?: StreamCreativeWorkflowEventsOptions,
): AsyncIterableIterator<CreativeWorkflowSseEvent>
Parameters
- workflowId: string
- options: StreamCreativeWorkflowEventsOptions = {}
Returns AsyncIterableIterator<CreativeWorkflowSseEvent>
- Defined in CreativeWorkflows/index.ts:311

Class CreativeWorkflowsApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CreativeWorkflowsApi

Properties

Protectedclient

Protectedeip712

Protectedlisteners

templates

Methods

cancel

Parameters

Returns Promise<CreativeWorkflowRecord>

Protectedemit

Type Parameters

Parameters

Returns void

events

Parameters

Returns Promise<CreativeWorkflowEvent[]>

get

Parameters

Returns Promise<CreativeWorkflowRecord>

list

Parameters

Returns Promise<CreativeWorkflowRecord[]>

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns () => void

once

Type Parameters

Parameters

Returns () => void

removeAllListeners

Type Parameters

Parameters

Returns void

reseed

Parameters

Returns Promise<ReseedCreativeWorkflowResult>

resume

Parameters

Returns Promise<ResumeCreativeWorkflowResult>

start

Parameters

Returns Promise<CreativeWorkflowRecord>

streamEvents

Parameters

Returns AsyncIterableIterator<CreativeWorkflowSseEvent>

Settings

On This Page

`Protected`client

`Protected`eip712

`Protected`listeners

`Protected`emit