Welcome to falaw’s documentation!

Contents:

• falaw
  • AccountStatus
  • AreaUsage
  • Asset
  • Beat
  • CacheUsage
  • CallOutcome
  • CallPlan
  • Character
  • ContentRef
  • CostEstimate
  • CostLine
  • CostRollup
  • Environment
  • ExecutionReport
  • FalAccountLocked
  • FalAssetFetchError
  • FalBadRequest
  • FalDurationOutOfRange
  • FalError
  • FalHTTPError
  • FalInsufficientFunds
  • FalModelHung
  • FalNonCanonicalArgument
  • FalRateLimited
  • FalServerError
  • FalTimeout
  • FalUnauthorized
  • ModelRecord
  • Plan
  • ProgressEvent
  • PruneCandidate
  • PruneReport
  • Result
  • Scene
  • Session
  • Shot
  • ToolSpec
  • Voice
  • animate_face()
  • apply_note_to_beat()
  • apply_note_to_scene()
  • beat_content_hash()
  • cache_get()
  • cache_put()
  • cache_stats()
  • cache_usage()
  • cached_call_fal()
  • call_fal()
  • call_plan_from_dict()
  • call_plan_to_dict()
  • cast_character()
  • cast_voice()
  • clear_subscribers()
  • composite_character_in_environment()
  • content_ref_for_url()
  • current_fal_key()
  • default_content_store()
  • default_url_fetcher()
  • drop_cache_entry()
  • edit_image()
  • establish_environment()
  • estimate_call_cost()
  • estimate_scene_cost()
  • execute_plan()
  • execute_plan_isolated()
  • extract_models_from_corpus()
  • fetch_model_prices()
  • generate_audio()
  • generate_image()
  • generate_image_with_refs()
  • image_to_video()
  • iter_render_scene()
  • lipsync()
  • llm_complete()
  • make_call_plan()
  • materialize_asset()
  • model_constraints()
  • parse_response()
  • parse_screenplay()
  • pick_model()
  • plan_animate_face()
  • plan_composite_character_in_environment()
  • plan_dependencies()
  • plan_edit_image()
  • plan_from_dict()
  • plan_generate_audio()
  • plan_generate_image()
  • plan_generate_image_with_refs()
  • plan_hash()
  • plan_image_to_video()
  • plan_lipsync()
  • plan_llm_complete()
  • plan_text_to_speech()
  • plan_to_dict()
  • prune_assets()
  • prune_content()
  • prune_manifests()
  • refresh_full_docs()
  • refresh_llms()
  • refresh_model_prices()
  • refresh_models_from_corpus()
  • refresh_state()
  • register_tool()
  • remove_background()
  • render_beat()
  • render_scene()
  • render_shot()
  • scene_from_dict()
  • storyboard_shot()
  • subscribe()
  • talking_avatar_from_text()
  • text_to_speech()
  • text_to_video()
  • unsubscribe()
  • upscale_image()
  • using_fal_credentials()
  • using_url_fetcher()
  • video_model_constraints()
  • voice_clone()
• falaw.__main__
• falaw.account
  • AccountStatus
  • health_check()
• falaw.backends
  • BackendExecutor
  • backends
  • get_backend_executor()
• falaw.base
  • CostEstimate
  • ModelRecord
  • ToolSpec
• falaw.bridges
• falaw.bridges.mcp
  • COSTED_TOOLS
  • FREE_TAG
  • build_mcp_server()
  • costed_tools()
  • register_tools()
  • serve()
• falaw.bridges.service
• falaw.bridges.skill
  • build_skill_md()
  • write_skill_files()
• falaw.cache
  • ASSETS_DIRNAME
  • cache_get()
  • cache_put()
  • cache_stats()
  • cached_call_fal()
  • drop_cache_entry()
  • emit_cache_hit()
  • materialize_asset()
• falaw.canonical
  • DFLT_BACKEND
  • cache_key_payload()
  • canonical_blob()
  • ensure_canonical()
  • plan_identity_payload()
• falaw.content
  • ConditionalOutcome
  • ContentRef
  • UrlFetcher
  • Validators
  • content_ref_for_url()
  • default_content_store()
  • default_url_fetcher()
  • is_immutable_url()
  • remembered_ref()
  • using_url_fetcher()
  • write_blob_to_file()
• falaw.core
  • call_fal()
  • current_fal_key()
  • using_fal_credentials()
• falaw.corpus
  • extract_models_from_corpus()
  • refresh_models_from_corpus()
• falaw.cost
  • CostLine
  • CostRollup
  • estimate_call_cost()
  • estimate_scene_cost()
• falaw.degrade
  • deferred_degrade_warnings()
  • emit_degradation()
• falaw.errors
  • FalAccountLocked
  • FalAssetFetchError
  • FalBadRequest
  • FalDurationOutOfRange
  • FalError
  • FalHTTPError
  • FalInsufficientFunds
  • FalModelHung
  • FalNonCanonicalArgument
  • FalRateLimited
  • FalServerError
  • FalTimeout
  • FalUnauthorized
  • translate()
• falaw.events
  • ProgressEvent
  • clear_subscribers()
  • emit()
  • subscribe()
  • unsubscribe()
• falaw.journal
  • Journal
  • JournalEntry
• falaw.local
  • concatenate_clips()
  • extract_thumbnail()
  • overlay_audio()
• falaw.operations
• falaw.operations._plan
  • GENERATE_AUDIO_DEFAULTS
  • plan_animate_face()
  • plan_composite_character_in_environment()
  • plan_edit_image()
  • plan_generate_audio()
  • plan_generate_image()
  • plan_generate_image_with_refs()
  • plan_image_to_video()
  • plan_lipsync()
  • plan_llm_complete()
  • plan_text_to_speech()
• falaw.operations.audio
  • generate_audio()
  • text_to_speech()
  • voice_clone()
• falaw.operations.avatar
  • animate_face()
  • lipsync()
  • talking_avatar_from_text()
• falaw.operations.images
  • composite_character_in_environment()
  • edit_image()
  • generate_image()
  • generate_image_with_refs()
  • remove_background()
  • upscale_image()
• falaw.operations.llm
  • apply_note_to_beat()
  • apply_note_to_scene()
  • llm_complete()
  • parse_screenplay()
• falaw.operations.preproduction
  • cast_character()
  • cast_voice()
  • establish_environment()
  • storyboard_shot()
• falaw.operations.render
  • iter_render_scene()
  • manifest_path_for()
  • render_beat()
  • render_scene()
  • render_shot()
• falaw.operations.video
  • image_to_video()
  • text_to_video()
• falaw.outcomes
  • CallOutcome
  • CallStatus
  • ExecutionReport
• falaw.plan
  • CONTENT_REF_PREFIX
  • CacheStatus
  • CallPlan
  • DFLT_CONCURRENCY
  • DFLT_FETCH_BYTES
  • FETCH_BYTES_ENVVAR
  • OutputKind
  • PLAN_DICT_SCHEMA
  • Plan
  • call_plan_from_dict()
  • call_plan_to_dict()
  • execute()
  • execute_isolated()
  • extract_first_url()
  • make_call_plan()
  • plan_dependencies()
  • plan_from_dict()
  • plan_hash()
  • plan_to_dict()
• falaw.pricing
  • MAX_429_RETRIES
  • MAX_IDS_PER_REQUEST
  • PRICING_URL
  • fetch_model_prices()
  • refresh_model_prices()
• falaw.prune
  • AreaUsage
  • CacheUsage
  • PruneCandidate
  • PruneReport
  • cache_usage()
  • prune_assets()
  • prune_content()
  • prune_manifests()
• falaw.refresh
  • DocSource
  • diff_against_previous()
  • fetch_if_changed()
  • is_stale()
  • refresh_full_docs()
  • refresh_llms()
  • refresh_state()
• falaw.registry
  • model_constraints()
  • pick_model()
  • register_tool()
  • video_model_constraints()
• falaw.results
  • Asset
  • Result
  • parse_response()
• falaw.scene
  • Beat
  • Character
  • Environment
  • Scene
  • Shot
  • Voice
  • beat_content_hash()
  • beat_id()
  • scene_from_dict()
• falaw.session
  • Session
• falaw.testing
  • Why not FALAW_FETCH_ARTIFACT_BYTES=0
  • Opting a test back into the real world
  • DFLT_LIVE_MARKERS
  • DFLT_SYNTHETIC_PREFIX
  • FakeAssets
  • LOCAL_HOSTNAMES
  • NON_NETWORK_SCHEMES
  • OutboundNetworkAttempt
  • blocked_outbound_network()
  • fake_assets()
  • is_network_url()
  • isolated_falaw_cache()
  • make_fake_assets_fixture()
  • make_isolated_falaw_cache_fixture()
  • make_no_outbound_network_fixture()
  • no_outbound_network()
  • serving_fake_assets()
  • synthetic_asset_bytes()

Indices and tables

• Index

• Module Index

• Search Page

Release: 0.0.40

Last change: Aug 31, 2026