HEheygen
Video Agent

Stop Video Agent Session

Changed on

Halts an active agent run at its next checkpoint. Partial results are preserved.

post/v3/video-agents/{session_id}/stop

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/video-agents/{session_id}/stop
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

session_idstring required

Session ID

Request body

StopSessionRequest required

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

Response

Successful response

Changes

  • 7dfa5e59b4f5Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status