HEheygen
Streaming

New Session

This endpoint is used to initiate a new streaming session.

post/v1/streaming.new

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v1/streaming.new
  • Auth
    API key in header X-API-KEY

Request body

qualitystring
avatar_idstring

ID of the Interactive Avatar you would like to use with the Streaming API

voice_namestring

voice to use

knowledge_basestring

Knowledge Base prompt used for chat task type.

video_encodingstring
disable_idle_timeoutboolean

By default session has a 2 minute idle timeout, setting to true disables it

versionstring

Response

200

object required

Changes

No recorded changes to this operation across all 1 revision of this API.