The ioGates Comment API

Manage comments on media files with ioGates' Comment API. Create, retrieve, update, and delete comments, including support for replies and time codes for precise feedback within shared content.

The Comment API in ioGates facilitates robust interaction with media content by allowing users to add, view, update, and delete comments. This API supports nuanced conversations through replies and the association of comments with specific time codes, enhancing collaborative review processes.

URL: /api/comment

Authorisation: A Bearer token is required, which is obtained from the auth token API.
Example:

Authorisation: Bearer 123-BodrEJHrC43KejPcM0nzTl05gUMi3i8ruzGN

Creating Comments

Method: POST

Request Body

file_id (Required): The ID of the file to which the comment is being added.
text (Required): The comment text, with \n for line breaks.
parent (Optional): To reply to an existing comment, include the ID of the parent comment.
tc (Optional): A list of time code objects for pinpointing the comment within the video. Each object includes in and out parameters, indicating the in/out points in milliseconds.

Receiving Comments

This is the response.

URL: /api/comment/{id}

Method: GET

Response:

id	Integer. The comment id.
file_id	Integer. The file id.
owner	User profile for the owner of the share. Object contains: id, username, realname, accountname, email, address, mobile, expires, and status. Status may be: Active, Inactive, Blocked, or ValidationRequired.
removed	Boolean. Deleted comments are marked removed.
created	String. Creation date.
parent	Integer or null. If the comment is a reply, this is the parent comment.
text	The text.
tc	A list of time code objects associated with the comment. Each object has a in and out parameter. Times are are milliseconds into file (not including any source offset).