Create comment

POST

https://api.frame.io/v4/accounts/:account_id/files/:file_id/comments

POST

/v4/accounts/:account_id/files/:file_id/comments

1 from frameio import Frameio
2 
3 client = Frameio(
4     base_url="https://api.frame.io",
5     token="YOUR_TOKEN_HERE"
6 )
7 
8 client.comments.create(
9     account_id="d1a4e63a-a0ee-4e80-bfec-b3a720c858e1",
10     file_id="e2b8d823-caf2-4dfe-8c2f-00e14414d23a",
11     data={
12         "text": "This is great!",
13         "annotation": "[{\"tool\":\"rect\",\"color\":\"#F22237\",\"size\":8,\"x\":0.277726001863933,\"y\":0.12909555568499534,\"w\":0.3153168321877913,\"h\":0.5308131407269339,\"ix\":0.277726001863933,\"iy\":0.12909555568499534,\"radius\":8}]",
14         "completed": False,
15         "page": 4,
16         "timestamp": 1.1
17     }
18 )

Try it

201Created

1 {
2   "data": {
3     "annotation": "annotation",
4     "completed_at": "2024-01-15T09:30:00Z",
5     "completer_id": "string",
6     "created_at": "2024-02-02T21:19:24.828948Z",
7     "file_id": "4ae08df1-b419-4897-aba5-560198a18237",
8     "id": "52a1032a-63a3-44a3-9ce5-f904fc158e23",
9     "page": 1,
10     "text": "This is great!",
11     "text_edited_at": "2024-02-02T21:19:24.828948Z",
12     "timestamp": 123,
13     "updated_at": "2024-02-02T21:19:24.828948Z"
14   }
15 }

Create a comment on a file.
Rate Limits: 100 calls per 1.00 minute(s) per account_user

Authentication

AuthorizationBearer

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

Path Parameters

account_idstringRequiredformat: "uuid"

A UUID String

file_idstringRequiredformat: "uuid"

A UUID String

Request

Comment params body

dataobjectRequired

Response

Created

dataobject

Authentication

Path Parameters

Request

Response

Errors