1 件のコメントを作成

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 }

アセットにコメントを残す

認証

AuthorizationBearer

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

パスパラメータ

asset_idstring必須形式: "uuid"

リクエスト

Comment to create or update

textstring必須

The body of the comment.

annotationstringオプション

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)

pageintegerオプション

Page number for a comment (documents only).

timestampdoubleオプション

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.

durationintegerオプション

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

privatebooleanオプション

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

pitchintegerオプションDeprecated

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

yawintegerオプションDeprecated

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

レスポンス

Comment success response

annotationstringオプション

completedbooleanオプション

completed_atstringオプション

completer_idstringオプション形式: "uuid"

has_repliesbooleanオプション

idstringオプション形式: "uuid"

like_countintegerオプション

ownerobjectオプション

ユーザーモデル

owner_idstringオプション形式: "uuid"

textstringオプション

timestampintegerオプション

エラー

401

Unauthorized Error

404

Not Found Error