Skip to content

voice/narrate

Standalone narration workflow — generate audio from text or a topic.

Category: voice
Source: workflows/voice/narrate.py

FieldTypeDefaultDescription
duration_secsinteger60Target duration in seconds
languagestring"en"Language for script and voice
moodstring"conversational"Tone for narration
narration_textobjectText to narrate (provide this OR topic)
regenerateobjectWhen set, this run is a regeneration. Workflows may read direction / keep / extra_instructions to modulate prompts; the engine persists parent_run_id and parent_variant_index as run lineage columns.
scriptobjectScript dict with full_narration key (populated by prepare_narration)
topicobjectTopic to generate narration from (provide this OR narration_text)
tts_modelobjectTTS model override
variantsinteger1Number of independent variant executions (1–10). When > 1, the engine runs the workflow N times with different sampling, producing N outputs.
voice_genderobject“male” or “female”
voice_idobjectExplicit voice ID override
voice_styleobjectVoice style preset (e.g. “narrator”, “warm”, “energetic-male”)

No schema defined.

prepare_narration → generate_narration_script → generate_narration_audio → collect_narration_output
TaskDescription
prepare_narrationValidate input and set up for narration.
generate_narration_scriptGenerate narration text from a topic using a simple LLM call.
generate_narration_audioGenerate TTS audio — delegates to the SDK voiceover stage.
collect_narration_outputSurface the key output fields for easy consumption.

Save the YAML below as my-run.yaml, edit the values, and run with the CLI or POST it to the API. Required fields are uncommented; optional knobs are documented above the input: block — copy any line under input: and uncomment to set.

workflow: voice/narrate
# Optional fields — copy any line(s) under `input:` and uncomment to set:
# Target duration in seconds
# duration_secs: 60
#
# Language for script and voice
# language: en
#
# Tone for narration
# mood: conversational
#
# Text to narrate (provide this OR topic)
# narration_text: null
#
# Script dict with full_narration key (populated by prepare_narration)
# script: null
#
# Topic to generate narration from (provide this OR narration_text)
# topic: null
#
# TTS model override
# tts_model: null
#
# "male" or "female"
# voice_gender: null
#
# Explicit voice ID override
# voice_id: null
#
# Voice style preset (e.g. "narrator", "warm", "energetic-male")
# voice_style: null
#
input: {}

Run it locally:

Terminal window
fab-workflow --from-file my-run.yaml

Or submit over the wire — the same file is the request body:

Terminal window
curl -X POST 'https://gofabric.dev/v1/workflows/runs?name=voice/narrate' \
-H 'Authorization: Bearer fab_xxx' \
-H 'content-type: application/yaml' \
--data-binary @my-run.yaml

Every workflow also accepts the universal WorkflowInput fields — variants (1–10 fan-out) and regenerate (creative-direction hints with run lineage). See Run-specs (YAML / TOML / JSON) for the full top-level shape (metadata, priority, bundle, parent, etc.).

  • Last user task collect_narration_output has no Pydantic return type — workflow output schema is null. Declare a WorkflowOutput subclass and pass it to Flow(output=…) for a strict contract.
  • Task generate_narration_audio has no Pydantic types — contract is opaque to consumers.