List comments | Frame.io API Documentation

1 from frameio import Frameio 2 3 client = Frameio( 4 base_url="https://api.frame.io" 5 ) 6 7 client.comments.index( 8 account_id="88c8ffe8-2450-47ef-bd85-2549e080a62f", 9 file_id="a96b29a6-4e65-4101-8616-b44e527d84b1" 10 )

1 { 2 "data": [ 3 { 4 "annotation": "annotation", 5 "created_at": "2024-02-02T21:19:24.828948Z", 6 "file_id": "4ae08df1-b419-4897-aba5-560198a18237", 7 "id": "31ed688d-7bd9-4022-a93e-a18c2f2b8361", 8 "page": 1, 9 "text": "This is great!", 10 "text_edited_at": "2024-02-02T21:19:24.828948Z", 11 "timestamp": 123, 12 "updated_at": "2024-02-02T21:19:24.828948Z", 13 "owner": { 14 "active": true, 15 "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN", 16 "email": "user_email@example.com", 17 "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e", 18 "name": "Jon Doe" 19 }, 20 "replies": [] 21 }, 22 { 23 "annotation": "annotation", 24 "created_at": "2024-02-02T21:19:24.828948Z", 25 "file_id": "4ae08df1-b419-4897-aba5-560198a18237", 26 "id": "31ed688d-7bd9-4022-a93e-a18c2f2b8361", 27 "page": 1, 28 "text": "This is great!", 29 "text_edited_at": "2024-02-02T21:19:24.828948Z", 30 "timestamp": 123, 31 "updated_at": "2024-02-02T21:19:24.828948Z", 32 "owner": { 33 "active": true, 34 "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN", 35 "email": "user_email@example.com", 36 "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e", 37 "name": "Jon Doe" 38 }, 39 "replies": [ 40 { 41 "annotation": "annotation", 42 "created_at": "2024-02-02T21:19:24.828948Z", 43 "file_id": "4ae08df1-b419-4897-aba5-560198a18237", 44 "id": "31ed688d-7bd9-4022-a93e-a18c2f2b8361", 45 "page": 1, 46 "text": "This is great!", 47 "text_edited_at": "2024-02-02T21:19:24.828948Z", 48 "timestamp": 123, 49 "updated_at": "2024-02-02T21:19:24.828948Z" 50 } 51 ] 52 } 53 ], 54 "links": { 55 "next": "/v4/accounts/1234/workspaces/5678/projects?after=g3QAAAACZAACaWRtAAAAJGFiMmNiY2QzLWFkODQtNDQwMC05YTRkLWE1ZDRkMGE4ZTIxM2QABG5hbWVtAAAACVByb2plY3QgMg==" 56 }, 57 "total_count": 10 58 }

List comments on a given asset.

Rate Limits: 100 calls per 1.00 minute(s) per account

Path parameters

account_idstringRequiredformat: "uuid"

A UUID String

file_idstringRequiredformat: "uuid"

A UUID String

Query parameters

includeenumOptional

Include query parameter for comments

Allowed values:

afterstringOptional

Opaque Cursor query param for requests returning paginated results.

NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.

page_sizeintegerOptional>=1<=100Defaults to 50

Page size query param for requests

include_total_countbooleanOptionalDefaults to false

Page query param to include the count of all entities

Response

datalist of objects

Comments

linksobject

Links to paginated data

total_countinteger or null

Total count

Path parameters

Query parameters

Response

Errors