{ "opencollection": "1.0.0", "info": { "name": "HeyGen Account Streaming API", "version": "4.0.8" }, "request": { "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "items": [ { "info": { "name": "Streaming", "type": "folder" }, "items": [ { "info": { "name": "Send Task", "type": "http" }, "http": { "method": "POST", "url": "https://api.heygen.com/v1/streaming.task", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "This endpoint is used to send a text to an Interactive Avatar, prompting it to speak the provided text." }, { "info": { "name": "Close Session", "type": "http" }, "http": { "method": "POST", "url": "https://api.heygen.com/v1/streaming.stop", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "This endpoint is used to terminate an active streaming session." }, { "info": { "name": "Start Session", "type": "http" }, "http": { "method": "POST", "url": "https://api.heygen.com/v1/streaming.start", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "This endpoint is used to start the connection for an existing streaming session." }, { "info": { "name": "List Sessions", "type": "http" }, "http": { "method": "GET", "url": "https://api.heygen.com/v1/streaming.list", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "This endpoint is used to retrieve a list of currently active streaming sessions." }, { "info": { "name": "New Session", "type": "http" }, "http": { "method": "POST", "url": "https://api.heygen.com/v1/streaming.new", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "This endpoint is used to initiate a new streaming session." }, { "info": { "name": "Create Session Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.heygen.com/v1/streaming.create_token", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "This endpoint is used to generate a new access token for a streaming session." }, { "info": { "name": "Interrupt Task", "type": "http" }, "http": { "method": "POST", "url": "https://api.heygen.com/v1/streaming.interrupt", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "This endpoint is used to interrupt the speaking of an Interactive Avatar." }, { "info": { "name": "List Streaming Avatars", "type": "http" }, "http": { "method": "GET", "url": "https://api.heygen.com/v1/streaming/avatar.list", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "This API endpoint allows you to retrieve a list of public and custom interactive avatars." } ] } ], "bundled": true }