Sign in

v1

latestOpenAPI 3.1.02026-07-2416666272.6 KB
Public - Comments

Create comment

Creates a new comment on a video through the public review link.

Authentication

ParameterTypeDescription
link_idpathReview link identifier
tokenqueryUser session token

The token will be associated with the created comment. To edit or delete this comment later, use the same token. The token can be the same value as link_id or a unique identifier generated by the application.

Example: 550e8400-e29b-41d4-a716-446655440000

Behavior

To create a main comment:

  • Provide text, user_name and time (video timestamp in seconds)
  • The time must be less than or equal to the video duration

To create a reply to an existing comment:

  • Provide text, user_name and reply_to (UUID of the parent comment)
  • The time is automatically inherited from the parent comment

Limits

  • Maximum of 30 main comments per video
  • Maximum of 30 replies per comment
  • Text with maximum 500 characters

Requirements

  • The link must have allow_comment: true
  • The link must be active and not expired
post/public-video-review/{link_id}/comments

Path parameters

link_idstring uuid required

Review link UUID

Query parameters

tokenstring uuid required

User session token. This token will be associated with the created comment.

Request body

textstring required

Comment text. Does not allow HTML tags or special characters like < > { } [ ].

user_namestring required

Name of the user commenting. Allows letters, numbers, spaces and the characters - _ . @.

timeinteger

Video timestamp in seconds where the comment refers to. Required for main comments, optional for replies (inherits from parent).

Examples:

  • 90 = 1:30 (1 minute and 30 seconds)
  • 330 = 5:30 (5 minutes and 30 seconds)
  • 3600 = 1:00:00 (1 hour)
reply_tostring uuid

Parent comment UUID. When provided, creates a reply linked to the specified comment.

Example request

{
  "text": "The audio is low in this section, it would be good to increase the volume.",
  "user_name": "John Smith",
  "time": 330,
  "reply_to": "550e8400-e29b-41d4-a716-446655440001"
}

Response

Comment created successfully

idstring uuid

Comment unique UUID.

video_idstring uuid

UUID of the video the comment belongs to.

user_idstring uuid nullable

UUID of the user who created the comment (available only in private API).

user_namestring

Name of the user who created the comment.

textstring

Comment text.

status'open' | 'resolved'

Current comment status.

timeinteger

Video timestamp in seconds.

reply_tostring uuid nullable

Parent comment UUID (null for main comments).

avatarstring uri nullable

User avatar URL (available only in private API when user has an avatar).

created_atstring date-time

Comment creation date and time.

updated_atstring date-time

Last update date and time.

Example response

{
  "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "video_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "user_id": "1b4f677f-4f6e-459d-84e0-7c304d3dbf48",
  "user_name": "John Smith",
  "text": "The audio is low in this section.",
  "status": "open",
  "time": 330,
  "avatar": "https://cdn.pandavideo.com.br/avatars/user123.jpg",
  "created_at": "2025-01-15T10:30:00.000Z",
  "updated_at": "2025-01-15T10:30:00.000Z"
}