If this is your first time using the Frame.io Platform, check out our Quick Start instructions.
Welcome to Frame.io's official documentation portal. Frame.io is the market driver for professional video review and collaboration -- everything video teams need to keep the creative process moving, all in a single cloud-based workbench. With Frame.io, you can securely upload film projects, then share them with your team and clients for review. Accelerate feedback and approvals by providing a shared review environment. (For a more detailed feature list, see Frame.io Features).
Not every creative team, process, or software stack is exactly the same. That's where our Developer Platform comes in. The Frame.io Developer Platform allows you to handle common tasks using our API. Some popular use cases developers have used our API for include automatically adding existing files or folders to the Frame.io app, uploading new content, and managing teams.
Frame.io offers building blocks and guides for how to implement popular use cases with the Frame.io API. Building blocks are code snippets that show how to do a common task that reoccurs across projects. Guides provide end-to-end detail for how to implement a complete workflow.
This section shows you granular, individual tasks that you'll need to complete workflows featured in our Guides.
- Retrieve the Root Asset ID for a Project - ID retrieval is required for most tasks.
- Read Directory Lists and File Trees - When uploading or downloading an asset (file or folder), you often need to create a directory tree. Find out how here.
Guides piece together building blocks with detailed instructions explaining how to complete popular workflows.
- Upload an Asset to Frame.io - Upload a file or folder to the Frame.io app.
- Create and Work with Review Links
- Manage Team Members and Collaborators - Manage team members and collaborators.
- Scrape All Comments From a Project - Scrape comments and output them to a .csv file.
- Manage Version Stacks
- Work with Annotations
- Work with Audit Logs
If you want to create something new, the Frame.io Developer Platform offers a few options you can use to build your own feature:
Webhooks - Webhooks provide a way to leverage events that occur inside of Frame.io into notifications that can be sent to external systems for processing, API callback, and workflow automation. We offer two ways to work with webhooks. You can build something yourself or you can use Zapier.
Custom Actions - Custom actions allow you to build integrations directly into Frame.io as programmable UI components.
We love projects created by you! If you've built something cool that you want to share with the community, come share it in our developer forum.
Updated about a month ago
|Sign up for an Account|