Create comment | Frame.io API Documentation

from frameio import Frameio
from frameio.comments import CreateCommentParamsData
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.comments.create(
    account_id="d1a4e63a-a0ee-4e80-bfec-b3a720c858e1",
    file_id="e2b8d823-caf2-4dfe-8c2f-00e14414d23a",
    data=CreateCommentParamsData(
        text="This is great!",
        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}]",
        completed=False,
        page=4,
        timestamp=1.1,
    ),
)

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

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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error