Skip to main content

Overview

Delete an existing Video Agent using its unique Video Agent ID. Once deleted, the Video Agent can no longer be used for video conversations or assigned to future workflows.

Prerequisites

  • Bearer Token authentication
  • Valid Video Agent ID

Request

string
required
Bearer token for authenticated workspace access.
string
required
Unique identifier of the Video Agent to delete.

Response

boolean
Indicates whether the request completed successfully.
integer
HTTP status code returned by the API.
string
Confirmation message indicating that the Video Agent was deleted successfully.

Error Handling

Deleting a Video Agent is permanent and cannot be undone. Any workflows or applications using this Video Agent should be updated before deletion.
Before deleting a Video Agent, you may want to:
  • Retrieve its configuration using GET /api/video-agent/{id}.
  • Export or save any configuration you may need later.
  • Ensure it is no longer assigned to any active workflows or applications.