Skip to main content
POST
Send Feedback

Authorizations

x-api-key
string
header
required

HeyGen API key. Obtain from your HeyGen dashboard.

Headers

Idempotency-Key
string

Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9_\-:.]{1,255}$

Body

application/json

Request body for POST /v3/feedback.

resource_type
enum<string>
required

What the feedback is about. Use the name of the resource whose ID you send in resource_id: 'video' for an ID from POST /v3/videos, 'video_translation' for POST /v3/video-translations, 'video_agent_session' for POST /v3/video-agents, 'model_video' for POST /v3/models/videos, 'model_image_generation' for POST /v3/models/images, 'image_generation' for POST /v3/images, and so on. For a call that returns no resource ID, such as speech generation, use 'request' with the response's X-Request-Id.

Available options:
video,
video_translation,
video_agent_session,
video_generation,
model_video,
image_generation,
model_image_generation,
lipsync,
podcast,
voice,
avatar_group,
avatar_look,
brand_kit,
background_removal,
filler_word_removal,
ai_clipping,
audio_transcription,
music,
stems,
hyperframes_render,
video_analysis,
custom_agent_video,
workflow_run,
asset,
template,
request
Example:

"video"

resource_id
string
required

ID of the resource the feedback is about, as the API returned it.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$
Example:

"8d3c2f0a1b4e4c6d9e7f0a1b2c3d4e5f"

rating
enum<string> | null

Overall verdict on the result. Send a rating, a comment, or both.

Available options:
positive,
neutral,
negative
Example:

"negative"

comment
string | null

What worked or what went wrong, in plain words, up to 2000 characters. Be specific: name the moment, the element or the setting. Do not include personal data.

Maximum string length: 2000
Example:

"The lips drift out of sync after 0:12, and the second scene's background flickers."

tags
string[] | null

Up to 10 short reason keys in snake_case, each up to 64 characters, for grouping feedback. Any key is accepted; reuse the same keys across requests.

Maximum array length: 10
Example:
submitted_by
enum<string>
default:agent

Who the feedback comes from. 'agent' (the default) when your code or an AI agent judged the result; 'end_user' when you are passing on what one of your own users said.

Available options:
agent,
end_user

Response

Created.

data
FeedbackV3 · object

One piece of feedback, as stored.