Skip to main content
POST
/
v3
/
video-agents
/
{session_id}
/
stop
Stop Video Agent Session
curl --request POST \
  --url https://api.heygen.com/v3/video-agents/{session_id}/stop \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'
{
  "data": {
    "session_id": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

​
session_id
string
required

Session ID

Body

application/json

Request body for stopping a session (empty — no fields required).

Response

Successful response

​
data
StopSessionResponse · object

Response from stopping a session.