character_id, and attach the character
in a later session instead of creating it again.
The PixVerse R2 Persona reference has four pages. This overview comes first. The
schema lists every command and message. The
prompt guide covers the image, the persona,
and how to talk to the character. The tutorial
covers a character, a microphone, and a call, step by step.
PixVerse R2 Persona uses the same wire protocol as every other Reactor model. You open a session
with the Reactor class, send named commands, publish and receive
tracks, and receive messages. Its model name is reactor/pixverse-r2-persona. The
@reactor-models/pixverse-r2-persona typed SDK adds named methods
and React hooks to the same protocol.
At a glance
The model name,
reactor/pixverse-r2-persona, is the name that you pass to the SDK. It is also the
scope of a token. The short slug, pixverse-r2-persona, names the docs folder, the typed SDK, and
the row for the model on Pricing and billing.
Key features
A character from one image
Upload one clear picture, and give the character a name, a persona, and a voice. The character
is ready in a few seconds. Save its
character_id to use it again.Talk or type
When you publish your microphone, the character answers your speech. You can also send a line
with
say. Each sentence that the character speaks also arrives as a transcript line for
subtitles.Calls you can repeat
Start a call, end it, and start another call with the same character.
session_state tells you
when the character can hear you and when you receive its video and voice.Quick start
- npm
- pnpm
@reactor-models/pixverse-r2-persona typed SDK. Do not put your rk_ API key in browser code. To
create tokens, see Authentication.
How it works
- Connect to
reactor/pixverse-r2-persona. The firstsession_statehas the phaseidle. Publish yourmictrack now, so that the character hears you from the start of the call. - Call
list_voicesto see the voices. To usedefault_voice, skip this step. Upload one image. Then callcreate_characterwith the image, a name, and a persona. The phase moves tocharacter_readywithcharacter_idset. In a later session, callattach_characterwith that id instead. - Call
start_call. The phase moves throughstartingandconnectingtolive.speech_readybecomes true duringconnecting, about 2 seconds after the call opens. - Talk. Speak into the microphone, or send a line with
say. The character answers onmain_videoandmain_audio. Each sentence also arrives as atranscriptline. - Call
end_call, or let the call end by itself. The character stays current, sostart_callstarts the next call.
The character does not speak first. It waits for your first turn. To have the character greet
the person, wait until
speech_ready and video_receiving are both true. Then say a short line
such as “Hello!”. The character answers that line.The character does not answer speech that comes before speech_ready is true. It does not hear a
published microphone that sends no samples. Speak after the character finishes its answer. If you
speak while it answers, it may not hear you.