Realtime Sessions

Create realtime session

Changed on

Create a new realtime session with the specified model configuration. The returned ID is also the conversation ID used later to fetch transcripts and recordings from the avatar conversation endpoints.

post/v1/realtime_sessions

Request

  • Base URL
    https://api.dev.runwayml.com
  • URL
    https://api.dev.runwayml.com/v1/realtime_sessions
  • 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

model'gwm1_avatars' required

The realtime session model type.

maxDurationinteger

Maximum session duration in seconds.

personalitystring

Override the avatar personality for this session. If not provided, uses the avatar default.

startScriptstring

Override the avatar start script for this session. If not provided, uses the avatar default.

Response

Success

idstring uuid required

The ID of the created realtime session. This same value is later used as the conversation ID in the avatar conversation endpoints.

Changes

  • 1c0d2ae99f66Revision changes
    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added request discriminator

    • info

      added subschema #1 to the request body oneOf list

  • f411647abba7Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property