Create comment | Frame.io API Documentation

from frameio import Frameio, Anchor, AttachmentInput, LinkParams, TextReviewAnnotation, TextReviewAnnotationBounds
from frameio.comments import CreateCommentParamsData
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.comments.create(
    account_id="ef2d6e95-e019-474c-8dd8-fc945b7c6ba4",
    file_id="9c3076b8-808c-48d0-b89f-6a864b6c81ac",
    data=CreateCommentParamsData(
        text="This is great!",
        anchor=Anchor(
            x=0.5,
            y=0.5,
        ),
        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}]",
        attachments=[
            AttachmentInput(
                file_size=1024000,
                media_type="image/png",
                name="screenshot.png",
            )
        ],
        completed=False,
        duration=10,
        links=[
            LinkParams(
                end_index=13,
                start_index=5,
                url="https://www.example.com",
            )
        ],
        page=4,
        text_review_annotation=TextReviewAnnotation(
            bounds=[
                TextReviewAnnotationBounds(
                    height=42,
                    width=130,
                    x=12.5,
                    y=24,
                )
            ],
            selection_text="existing copy",
            suggested_text="updated copy",
            text_review_annotation_type="replace",
        ),
        timestamp="00:00:02:12",
    ),
)

{
  "data": {
    "annotation": "annotation",
    "attachments": [
      {
        "created_at": "2024-02-02T21:19:24.828948Z",
        "file_size": 1024000,
        "id": "87ae3485-186d-40d3-9213-167b34536c44",
        "media_type": "image/png",
        "name": "screenshot.png",
        "upload_urls": [
          "https://s3.amazonaws.com/bucket/part1?signature=..."
        ]
      }
    ],
    "completed_at": null,
    "completer_id": null,
    "created_at": "2024-02-02T21:19:24.828948Z",
    "duration": 10,
    "file_id": "4ae08df1-b419-4897-aba5-560198a18237",
    "id": "9d4118a0-6a82-421c-a5d7-15bf2e7e453a",
    "links": [
      {
        "end_index": 13,
        "start_index": 5,
        "text": "Test User",
        "url": "https://www.example.com"
      }
    ],
    "mentions": [
      {
        "end_index": 13,
        "start_index": 5,
        "text": "Test User",
        "user_id": "55420a8b-c5d5-457c-9d14-3013b0a03d4c"
      }
    ],
    "page": 1,
    "text": "This is great!",
    "text_edited_at": "2024-02-02T21:19:24.828948Z",
    "text_review_annotation": {
      "bounds": [
        {
          "height": 42,
          "width": 130,
          "x": 12.5,
          "y": 24
        }
      ],
      "selection_text": "existing copy",
      "suggested_text": "updated copy",
      "text_review_annotation_type": "replace"
    },
    "timestamp": 123,
    "updated_at": "2024-02-02T21:19:24.828948Z",
    "anchor": {
      "x": 0.5,
      "y": 0.5
    }
  }
}

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

認証

AuthorizationBearer

Bearer <token>形式のBearer認証。tokenは認証トークンです。

パスパラメータ

account_idstring必須形式: "uuid"

A UUID String

file_idstring必須形式: "uuid"

A UUID String

クエリパラメータ

timestamp_as_timecodebooleanオプション

リクエスト

Comment params body

dataobject必須

レスポンスヘッダー

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

レスポンス

Created

dataobject

エラー

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error