Avatars

Create avatar

Changed on

Create a new avatar with a reference image and voice.

post/v1/avatars

Request

  • Base URL
    https://api.dev.runwayml.com
  • URL
    https://api.dev.runwayml.com/v1/avatars
  • Auth
    HTTP bearer

Headers

X-Runway-Version'2024-11-06' required

The version of the RunwayML API being used. You can read more about versioning here.

Request body

namestring required

The character name for the avatar.

personalitystring required

System prompt defining how the avatar should behave in conversations.

startScriptstring

Optional opening message that the avatar will say when a session starts.

documentIdsstring[]

Optional list of knowledge document IDs to attach to this avatar. Documents provide additional context during conversations.

imageProcessing'optimize' | 'none'

Controls image preprocessing. optimize improves the image for better avatar results. none uses the image as-is; quality not guaranteed.

Example request

{
  "referenceImage": "https://example.com/image.jpg",
  "personality": "You are a helpful support agent assisting users with their account questions. Be friendly, patient, and provide clear step-by-step guidance.",
  "startScript": "Hello! How can I help you today?"
}

Response

Success

OR
OR

Changes