Leave a Reply on a Comment | Frame.io API Documentation

Path parameters

comment_idstringRequiredformat: "uuid"

Request

Comment to create or update

textstringRequired

The body of the comment.

annotationstringOptional

Serialized list of geometry and/or drawing data.

Learn more here

Serialized list of geometry and/or drawing data. Learn more [here](https://developer.frame.io/docs/workflows-assets/working-with-annotations)

pageintegerOptional

Page number for a comment (documents only).

timestampdoubleOptional

Timestamp for the comment, in frames, starting at 0.

Comments can “global” to an asset in which you don’t provide the timestamp, or if you’re reviewing a “document” like a PDF then you would use page instead of timestamp to identify where the comment belongs.

durationintegerOptional

Used to produce range-based comments, this is the duration measured in frames.

privatebooleanOptional

Set to true to make your comment a “Team-only Comment” that won’t be visible to anonymous reviewers or Collaborators.

pitchintegerOptionalDeprecated

Pitch measurement for the comment (360deg video only).

yawintegerOptionalDeprecated

Yaw measurement for the comment (360deg video only).

Response

Comment success response

annotationstring or null

completedboolean or null

completed_atstring or null

completer_idstring or nullformat: "uuid"

has_repliesboolean or null

idstring or nullformat: "uuid"

like_countinteger or null

ownerobject or null

User model

owner_idstring or nullformat: "uuid"

textstring or null

timestampinteger or null

1	import requests
2
3	url = "https://api.frame.io/v2/comments/comment_id/replies"
4
5	payload = { "text": "string" }
6	headers = {"Content-Type": "application/json"}
7
8	response = requests.post(url, json=payload, headers=headers)
9
10	print(response.json())

1	{
2	"annotation": "[...]",
3	"completed": false,
4	"completed_at": "2020-07-15T17:30:00.906305Z",
5	"completer_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
6	"has_replies": true,
7	"id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
8	"like_count": 10,
9	"owner": {
10	"email": "jane@frame.io",
11	"name": "Jane Doe",
12	"account_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
13	"id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
14	},
15	"owner_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
16	"text": "This is a comment.",
17	"timestamp": 60
18	}

Path parameters

Request

Response

Errors