Runway · Example Payload

Runway Create Avatar Example

Video GenerationImage GenerationArtificial IntelligenceMachine LearningGenerative AIAvatarsCharactersWebRTCCreative Tools

Runway Create Avatar Example is an example object payload from Runway, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

requestresponsecreate_session_example

Example Payload

{
  "request": {
    "method": "POST",
    "url": "https://api.dev.runwayml.com/v1/avatars",
    "headers": {
      "Authorization": "Bearer YOUR_RUNWAY_API_KEY",
      "X-Runway-Version": "2024-11-06",
      "Content-Type": "application/json"
    },
    "body": {
      "name": "Aria - Customer Support Agent",
      "referenceImage": "https://example.com/assets/aria-reference.jpg",
      "personality": "You are Aria, a friendly and helpful customer support agent for TechCorp. Always greet users warmly, answer questions concisely, and escalate complex issues to human agents. Be empathetic and professional.",
      "voice": {
        "type": "runway-live-preset",
        "presetId": "aria-professional-v1"
      },
      "openingMessage": "Hi! I'm Aria, your TechCorp support assistant. How can I help you today?"
    }
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Aria - Customer Support Agent",
      "createdAt": "2026-05-02T12:00:00Z"
    }
  },
  "create_session_example": {
    "request": {
      "method": "POST",
      "url": "https://api.dev.runwayml.com/v1/realtime_sessions",
      "headers": {
        "Authorization": "Bearer YOUR_RUNWAY_API_KEY",
        "X-Runway-Version": "2024-11-06",
        "Content-Type": "application/json"
      },
      "body": {
        "model": "gwm1_avatars",
        "avatar": {
          "type": "custom",
          "avatarId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
        },
        "maxSessionDurationSeconds": 300
      }
    },
    "response": {
      "status": 200,
      "body": {
        "id": "sess-123e4567-e89b-12d3-a456-426614174000",
        "status": "READY",
        "serverUrl": "wss://webrtc.runway.com/session/sess-123e4567",
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
        "roomName": "room-sess-123e4567"
      }
    }
  }
}