For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer Tools
CommunityContact UsConsole
HomeAPI ReferenceDocsChangelog
HomeAPI ReferenceDocsChangelog
  • API Reference
      • POSTCreate comment
      • DELDelete comment
      • GETList comments
      • GETShow comment
      • PATCHUpdate comment
Logo
Developer Tools
CommunityContact UsConsole
API ReferenceComments

Show comment

GET
https://api.frame.io/v4/accounts/:account_id/comments/:comment_id
GET
/v4/accounts/:account_id/comments/:comment_id
1from frameio import Frameio
2
3client = Frameio(
4 token="YOUR_TOKEN_HERE",
5)
6
7client.comments.show(
8 account_id="4185f7a7-e7b4-4c95-9bfd-9ebd636885f4",
9 comment_id="e6f4665e-98ef-43c8-9f04-2bab607b6e9b",
10)
1{
2 "data": {
3 "annotation": "annotation",
4 "completed_at": {},
5 "completer_id": {},
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 "owner": {
15 "active": true,
16 "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",
17 "email": "user_email@example.com",
18 "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
19 "name": "Jon Doe"
20 },
21 "replies": []
22 }
23}

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

Was this page helpful?
Previous

Update comment

Next

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequiredformat: "uuid"
A UUID String
comment_idstringRequiredformat: "uuid"
A UUID String

Query parameters

includeenumOptional
Include query parameter for comments
Allowed values:

Response

OK
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