Create a Comment

POST

https://api.frame.io/v2/assets/:asset_id/comments

POST

/v2/assets/:asset_id/comments

1 import requests
2 
3 url = "https://api.frame.io/v2/assets/asset_id/comments"
4 
5 payload = { "text": "string" }
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.post(url, json=payload, headers=headers)
12 
13 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 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

asset_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

annotationstringOptional

completedbooleanOptional

completed_atstringOptional

completer_idstringOptionalformat: "uuid"

has_repliesbooleanOptional

idstringOptionalformat: "uuid"

like_countintegerOptional

ownerobjectOptional

User model

owner_idstringOptionalformat: "uuid"

textstringOptional

timestampintegerOptional

Errors

401

Unauthorized Error

404

Not Found Error