Eve library

ISIS v2 VFX Element Pack SDK End-to-End Examples

Guide

Revision 1

On this page

Generated: 2026-08-02T18:33:40.930Z Checklist: MXA-0424 (ISIS2-00622) Asset Family: vfx-element-pack Phase: Phase 4 | Milestone: M3 Launch (2026-07-27 to 2026-10-30)

Objective#

Expose vfx-element-pack workflows via @isis/client with typed SDK request contracts and end-to-end example builders covering direct runs, chained orchestration, and batch variants.

Typed Workflow Contracts#

Workflow ID Generation Type Required Parameters
vfx-element-pack-baseline text-to-image effect_type, style_profile, shot_context, lighting_interaction_profile, medium_profile, motion_profile, element_density_profile, turbulence_profile, emission_color_profile, alpha_background_mode, render_resolution_class, camera_lens_profile, compositing_intent, seed, width, height, steps, cfg_scale
vfx-element-pack-image-conditioned text-to-image style_reference_image, use_composition_reference, reference_strength, composition_strength, prompt_template_id, style_profile_id, color_script, lens_profile, effect_type, style_profile, shot_context, lighting_interaction_profile, medium_profile, motion_profile, element_density_profile, turbulence_profile, emission_color_profile, alpha_background_mode, render_resolution_class, camera_lens_profile, compositing_intent, seed, width, height, steps, cfg_scale
vfx-element-pack-control-conditioned text-to-image use_pose_control, use_depth_control, use_segmentation_control, use_normal_control, use_canny_control, use_lineart_control, pose_strength, depth_strength, segmentation_strength, normal_strength, canny_strength, lineart_strength, prompt_template_id, style_profile_id, color_script, lens_profile, effect_type, style_profile, shot_context, lighting_interaction_profile, medium_profile, motion_profile, element_density_profile, turbulence_profile, emission_color_profile, alpha_background_mode, render_resolution_class, camera_lens_profile, compositing_intent, seed, width, height, steps, cfg_scale
vfx-element-pack-consistency-locked text-to-image continuity_profile_id, continuity_profile_revision, continuity_locked_dimensions, scene_profile_id, style_profile_id, scene_anchor_reference_image, use_scene_anchor_reference, use_layout_reference, use_element_reference, use_lens_reference, use_style_lock, prompt_template_id, focal_length_mm, color_script, lens_profile, scene_anchor_lock_strength, layout_lock_strength, element_lock_strength, lens_lock_strength, style_lock_strength, effect_type, style_profile, shot_context, lighting_interaction_profile, medium_profile, motion_profile, element_density_profile, turbulence_profile, emission_color_profile, alpha_background_mode, render_resolution_class, camera_lens_profile, compositing_intent, seed, width, height, steps, cfg_scale

SDK Surface Checks#

Category Method Present
workflow-resource runVfxElementPack true
workflow-resource runVfxElementPackBaseline true
workflow-resource runVfxElementPackImageConditioned true
workflow-resource runVfxElementPackControlConditioned true
workflow-resource runVfxElementPackConsistencyLocked true
client-shortcut runVfxElementPackBaseline true
client-shortcut runVfxElementPackImageConditioned true
client-shortcut runVfxElementPackControlConditioned true
client-shortcut runVfxElementPackConsistencyLocked true
examples-module createVfxElementPackEndToEndExamples true
examples-module executeVfxElementPackEndToEndExamples true

Verification Commands#

  • pnpm --filter @isis/client exec vitest run src/resources/workflows.vfx-element-pack.spec.ts src/examples/vfx-element-pack.spec.ts
  • pnpm --filter @isis/client exec vitest run src/resources/workflows.route-parity.spec.ts

Acceptance Criteria#

  • SDK exposes typed run methods for baseline, image-conditioned, control-conditioned, and consistency-locked vfx-element-pack workflows.
  • SDK runtime validation rejects invalid generation types and malformed variant parameters before transport dispatch.
  • SDK exports end-to-end examples for direct runs plus chain and batch orchestration payloads.
  • SDK root exports and client shortcut methods expose the vfx-element-pack workflow surface for downstream consumers.

Traceability#

  • Checklist item: MXA-0424
  • Ticket key: ISIS2-00622
  • Source references:
    • docs/domains/isis/remediation-v2/ISIS_REMEDIATION_V2_TICKETS.json
    • docs/domains/isis/remediation-v2/ISIS_V2_VFX_ELEMENT_PACK_REQUIREMENTS_BRIEF.json
    • docs/domains/isis/remediation-v2/ISIS_V2_VFX_ELEMENT_PACK_GENERATION_API_TYPED_REQUEST_CONTRACTS.json
    • libs/isis/client/src/resources/workflows.ts
    • libs/isis/client/src/resources/workflows.vfx-element-pack.spec.ts
    • libs/isis/client/src/examples/vfx-element-pack.ts
    • libs/isis/client/src/examples/vfx-element-pack.spec.ts
    • libs/isis/client/src/client.ts
    • libs/isis/client/src/index.ts
    • libs/isis/client/src/resources/index.ts
    • ISIS_TODOS_2.md