Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HeyGen Streaming API

Streaming avatar session lifecycle and task endpoints.

HeyGen Streaming API is one of 13 APIs that HeyGen publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Streaming. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 8 paths. It is described by OpenAPI 3.1.0, at version 4.0.8.

Requests are made against a single base URL, https://api.heygen.com.

8 operations 8 paths 0 schemas 2 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.0.8
Base URL
https://api.heygen.com/v3
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

HeyGen Streaming API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (sec0). An API key is passed in the header as X-API-KEY (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 2 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Streaming 8

Streaming avatar session lifecycle and task endpoints.

POST
/v1/streaming.task
Send Task
send-task body → 200400
POST
/v1/streaming.stop
Close Session
close-session body → 200400
POST
/v1/streaming.start
Start Session
start-session body → 200400
GET
/v1/streaming.list
List Sessions
list-sessions → 200400
POST
/v1/streaming.new
New Session
new-session body → 200400
POST
/v1/streaming.create_token
Create Session Token
create-session-token body → 200400
POST
/v1/streaming.interrupt
Interrupt Task
interrupt-task body → 200400
GET
/v1/streaming/avatar.list
List Streaming Avatars
streaming-avatar-list → 200400

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heygen-streaming-api-openapi.yml Raw ↑

Other APIs HeyGen publishes across the network.

HeyGen API
HeyGen Account API
HeyGen Assets API
HeyGen Avatars API
HeyGen Digital Twins API
HeyGen Folders API
HeyGen Photo Avatars API
HeyGen Templates API
HeyGen Video Translation API
HeyGen Videos API
HeyGen Voices API
HeyGen Webhooks API