Documentation

Build personalized video workflows with BHuman.

Use these docs to create templates, map campaign data, personalize variables, add dynamic backgrounds, generate presenter videos, publish product updates, recover carts, and connect BHuman to your own tools.

Start with AI StudioOpen API guide

System model

How BHuman works

  1. 01

    Create or import a source video

    Start in AI Studio with a recorded/uploaded presenter video, or generate the presenter, voice, and script in Speakeasy.
  2. 02

    Mark the parts that change

    Use variables for spoken text, URLs, background assets, CTA destinations, and other row-specific values.
  3. 03

    Connect data

    Send rows through CSV, Zapier, Pabbly, Leadr, or the API. Each row maps to the same template variables.
  4. 04

    Render and deliver assets

    BHuman renders asynchronously, then returns video status, share links, MP4 URLs, thumbnails, GIF previews, callback metadata, or product-specific publishing states.

Concepts

Terms used across the product and API

Template
The AI Studio source video that defines the presenter, script, transcript, voice behavior, and variables.
Variable
A personalized field such as a name, company, CTA URL, image URL, website URL, or background asset.
Campaign
A generation workflow that maps rows from CSV, Zapier, Pabbly, Leadr, or the API to a template.
Background segment
A timed section where BHuman places a website screenshot, LinkedIn capture, uploaded media, direct media URL, generic desktop, or keyed chroma scene behind the presenter.
Generated video
A render result with status, row index, share URL, MP4 URL, thumbnail, GIF preview, error message, and pipeline execution metadata when available.
Callback
A URL BHuman posts to after asynchronous rendering so your workflow can attach generated assets to a record.

Choose your path

Start with the workflow you are shipping

Create a reusable templateRecord, upload, or import a presenter video, then prepare it for personalization.Review all AI Studio featuresScan the full feature set across templates, variables, samples, campaigns, delivery, and API automation.Launch a no-code campaignUpload data, map variables, add optional background media, and generate videos.Generate from your productUse API keys, campaign endpoints, callbacks, polling, and generated asset fields.Build with a generated presenterCreate a presenter, voice, script, and final render in Speakeasy.Ship product update videosConnect GitHub, review summaries, create video plans, capture walkthroughs, and publish updates.Recover Shopify carts with videoConnect Shopify, install the recovery snippet, test the flow, and track recovered checkouts.Run Leadr outreachConnect accounts, discover audiences, build workflows, attach optional video, and monitor campaign results.

Browse

Browse by capability

AI Studio

DashboardFind templates, campaigns, support resources, orders, and onboarding.Feature referenceScan the full live AI Studio feature set by workflow stage.Recording and uploadsRecord in BHuman or upload an existing source video.VariablesName, map, and time the personalized fields.Transcript editorCreate variables from transcript selections and manage timing.Voice and lip syncChoose natural voice samples and control lip sync behavior.Preview and samplesGenerate sample previews, choose modes, and check template readiness.Text-to-videoGenerate presenter videos from script text and text-to-video templates.SubtitlesGenerate subtitles from the edited transcript.Template libraryUse, publish, and manage starter templates.Script generatorGenerate a recording script from a use case and CTA.Generated video libraryReview completed renders, progress states, and output history.

Campaign features

Background modeUse timed websites, media, LinkedIn captures, and chroma scenes.Data sourcesCSV, Zapier, Pabbly, Leadr, and API data paths.Generated assetsRead render status, share URLs, MP4s, thumbnails, and GIFs.Campaign monitoringTrack campaign stages, failures, retry actions, and attention states.Manual audio recordingRecord variable-specific audio when campaign rows need custom voice takes.Landing pagesUse generated videos with hosted or custom CTA pages.Landing page builderBuild BHuman pages with video, text, image, input, Calendly, HTML, and CTA widgets.Email deliverySend generated videos through connected mailboxes with variables and scheduling.SMS deliverySend generated video thumbnails and links by MMS/SMS.Send it for meLet BHuman help launch a finished campaign.

Speakeasy

SpeakeasyUnderstand the Speakeasy workspace and generated video flow.Projects and presentersCreate projects, choose presenters, upload photos, capture webcam images, or generate presenters with AI.Script and voiceChoose voice modes, generate scripts, clone samples, tune delivery, and preview narration.Rendering and sharingStart renders, monitor progress, download videos, import to AI Studio, and connect social channels.Product updatesTurn GitHub changes into summaries, video plans, walkthroughs, and published updates.Shopify RecoverConnect Shopify and add personalized abandoned checkout recovery videos.

Leadr

LeadrRun LinkedIn-style outreach with optional personalized video.Feature referenceScan the full live Leadr feature set by workflow stage.Leadr accountsConnect, update, disconnect, and troubleshoot outreach accounts.Leadr campaign builderBuild audiences, messages, variables, timing, and video settings.Leadr resultsMonitor campaign URLs, states, results, errors, and management actions.

Persona

PersonaCreate an embeddable AI persona with face and voice settings.Persona trainingRecord required, training, and response videos for a Persona.Knowledge baseAdd training data and generate prompt-response knowledge.Prompt responsesCreate, edit, approve, and delete Persona prompt-response pairs.Persona voice widgetConfigure text, call, voice-note, video-call, language, and widget layout.Persona email automationConnect Persona email senders, receivers, reply delays, and blacklists.Persona meetingsConnect two Personas for a meeting and receive a report.

Account settings

Plans and billingManage plans, add-ons, billing history, credits, and plan gates.Team workspacesSwitch workspaces, pool credits, and add or remove team members.Profile settingsUpdate names, review login email, and sign out.Email accessConnect Gmail app passwords or custom SMTP/IMAP mailboxes.Phone numbersProvision sending numbers and forward replies or calls.AffiliatesActivate affiliate links, copy referral URLs, and review payout metrics.Agency registrationRegister an agency profile and manage agency-facing setup.

Developers

API guideAuthenticate, generate videos, and collect render outputs.API keysGenerate and protect client credentials.WebhooksCreate saved destinations and process callbacks.ZapierConnect BHuman to no-code automation workflows.PabblySend simple object-style webhook payloads.Custom domainsAttach a branded domain to BHuman-hosted pages.

Reference

Developer reference

Use the docs pages for integration guidance and the live Swagger UI for exact endpoint schemas before launching production automation.

API guideAuthentication, request shapes, generation endpoints, responses, and Swagger.API keysWhere credentials live and how to keep them secure.WebhooksSaved destinations and callback handling.Generated assetsPolling fields, statuses, MP4s, thumbnails, and GIFs.
  • Use HTTPS callback URLs and allow repeated deliveries.
  • Store generated video IDs so callbacks and polling responses can be reconciled.
  • Keep variable names stable once a campaign, Zapier, Pabbly, or API workflow is live.