Stop Video Agent session

Stop an in-progress agent run. The agent stops at the next checkpoint and partial results are preserved.

POST /v3/video-agents/sessions/{session_id}/stop

Stop Video Agent session

cURL

curl --request POST \
  --url https://api.heygen.com/v3/video-agents/sessions/{session_id}/stop \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'

200

{}

Authorizations

ApiKeyAuthBearerAuth

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

200

application/json

Successful response

data · StopSessionResponse · object

Response from stopping a session.

Show child attributes