Greating
We need to automatically export (load) all comments from our Frame.io projects for internal processing and archiving.
I’ve tried doing this through the Frame.io API, but I wasn’t even able to get a list of projects, even though I granted “only view” permissions to both the workspace and the project.
Could you please advise what permissions or API scopes are required to:
Retrieve a list of all projects within a workspace, and export all comments from these projects automatically?
If there’s an existing workflow, API endpoint, or integration that can help automate this process, I’d really appreciate your guidance or documentation reference.
Hi @RomanHishchak1 you will need to traverse all files in a project to list out the comments. Since all comments are attached to files, there’s no way to list out all comments in a project directly.
You would use the List Projects endpoint, then use the List Folder Children with the root_folder_id from the returned projects to get all folders and files in the root_folder of the project, and then repeat for any/all folders.
For any projects you have been invited to (aka null when trying to return workspaces, you will need to use the List invited projects endpoint which is in our experimental version atm.
Search will (hopefully) improve this but it is not yet available.
Hello, We are working on integrating Frame.io into our workflow and plan to import comments from an external system. We are currently trying to figure out what permissions and API calls are required for this and how exactly this can be done. We would be very grateful for a ready-made solution. Please help clarify the following: What OAuth scopes or API permissions are required to read and create comments? What API endpoints are used to: get a list of comments; Please provide examples of requests (curl or HTTP) and request bodies (JSON). How exactly does the process of setting up access to Workspace work — what steps do we need to take so that we can send API requests (step-by-step instructions would be very helpful)? Is there a ready-made solution or example of a script/library for bulk import of comments (e.g. from CSV or JSON into Frame.io)? We would be grateful for examples (curl / Node.js / Python) and a short instruction on setting up access. Thank you in advance for your help!
hi @RomanHishchak1 The only scopes you need to implement is the initial authentication via Adobe IMS (you can read more about Authentication here) as the auth token will have all permissions you need to perform all calls with (if you get a 401 error that typically means you do not have your Frame.io account linked to an Adobe ID).
You can find all of our API references on the developer site which should answer all of your questions: https://developer.adobe.com/frameio/api/current/#tag/Comments/operation/comments.index
We will have a new version of the developer site coming in the next 2 weeks that you will be able to ask all of your questions to via AI (it’s built directly into the dev docs and only references our documentation and help articles). If you would like to get an early peak at this before we launch, please send me a DM and I would be happy to share the WIP site with you.