Comments

Comments in VEO are how groups collaborate around videos and tag sessions. Here we will look at how to add comments to video, reply to comments and retrieve those comments.

Comments come in two forms generally in VEO:

  • Comments made against a video which are based around the /video/{videoId}/comments endpoints
  • Comments made against tags in a tag session which are also referred to as Notes. These are available in the /taggedvideo/{TagSessionId}/tags/{TagId}/notes endpoints.
GET/videos/{VideoId}/comments

Get video comments

To retrieve a list of comments on a video you perform a simple GET request. The result of the request includes the comments and any child comments that a comment has (replies). Comments can be a maximum of 2 levels deep.

You can't reply to a reply

Request

GET
/videos/{VideoId}/comments
curl --location 'https://api.veo.co.uk/api/videos/{VideoId}/Comments' \
--header 'Authorization: Bearer {Token}' \
POST/videos/{VideoId}/comments

Create a comment

To post a comment on a video you use the following properties:

  • Name
    ParentCommentId
    Type
    long
    Description

    If you are replying to a comment, include it's id here.

  • Name
    Message
    Type
    string
    Description

    Your comment message

The response should be a 200 - OK.

Request

POST
/videos/{VideoId}/comments
curl --location 'https://api.veo.co.uk/api/videos/{VideoId}/Comments' \
--header 'Authorization: Bearer {Token}' \
--data '{
    "ParentCommentId": 0,
    "Message": "This is a nice video"
}'
DELETE/videos/{VideoId}/comments/{CommentId}

Delete a comment

To delete a comment you must be the person who made the comment.

The response should be a 200 - OK.

Request

DELETE
/videos/{VideoId}/comments/{CommentId}
curl --location --request DELETE 'https://api.veo.co.uk/api/videos/{VideoId}/comments/{CommentId}' \
--header 'Authorization: Bearer {Token}' \
GET/taggedvideo/{TagSessionId}/Notes

Get tag session notes

To retrieve a list of comments on a tag session you perform a simple GET request. The result of the request includes the notes and any child notes that a note has (replies). Notes can be a maximum of 2 levels deep.

You can't reply to a reply

Request

GET
/taggedvideo/{TagSessionId}/Notes
curl --location 'https://api.veo.co.uk/api/taggedvideo/{TagSessionId}/Notes' \
--header 'Authorization: Bearer {Token}' \
POST/taggedvideo/{{TaggedVideoId}}/tags/{{TagId}}/Notes

Create a tag session note

To post a comment on a tag session you use the following properties:

  • Name
    ParentCommentId
    Type
    long
    Description

    If you are replying to a comment, include it's id here.

  • Name
    Message
    Type
    string
    Description

    Your comment message

The response should be a 200 - OK.

Request

POST
/taggedvideo/{{TaggedVideoId}}/tags/{{TagId}}/Notes
curl --location 'https://api.veo.co.uk/api/taggedvideo/{{TaggedVideoId}}/tags/{{TagId}}/Notes' \
--header 'Authorization: Bearer {Token}' \
--data '{
    "ParentCommentId": 0,
    "Message": "I agree with this tag"
}'
DELETE/taggedvideo/{TaggedVideoId}/tags/{TagId}/notes/{NoteId}

Delete a tag session note

To delete a note you must be the person who made the note.

The response should be a 200 - OK.

Request

DELETE
/taggedvideo/{TaggedVideoId}/tags/{TagId}/notes/{NoteId}
curl --location --request DELETE 'https://api.veo.co.uk/api/taggedvideo/{TaggedVideoId}/tags/{TagId}/notes/{NoteId}' \
--header 'Authorization: Bearer {Token}' \

Other endpoints

For other endpoints please visit the swagger documentation.

View the swagger docsSwagger JSON