Stop Video Agent Session

cURL

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 '{}'

Responses

• 200
• 400
• 401
• 404
• 429

{
  "data": {
    "session_id": "<string>"
  }
}

Authorizations

• x-api-key
  Type: string
  In: header
  Required: Yes
  Description: HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

• session_id
  Type: string
  Required: Yes
  Description: Session ID.

Body

• application/json
  Description: Request body for stopping a session (empty — no fields required).

Response

Successful response

• 200
  • data
    Type: StopSessionResponse · object
    Description: Response from stopping a session.