DOCSEARCHbyAlgolia
Submit Docs

Frame.io Developer Documentation

website·Indexed 43 days ago

https://developer.frame.io/docs/

Developer resources and documentation for integrating Frame.io with other workflow tools.

Tokens
460
Snippets
2
Records
6
Agent score
20%

What's inside Frame.io

  1. Build event-based workflows with Webhooks and Custom Actions

    Frame.io offers two primary ways to extend workflows based on events:

    1. Webhooks: Send notifications of Frame.io events to external URLs for processing or automation. These can be used with custom receivers or no-code tools like Zapier, Integromat, Pabbly Connect, and Pipedream.
    2. Custom Actions: Create programmable UI components integrated directly into the Frame.io interface.

  3. Get started with the Frame.io Developer Platform

    To begin integrating with Frame.io, you must have a Frame.io account. The initial setup involves signing into the Developer Portal and creating a Developer Token. You can verify your token by making a GET request to the /v2/me endpoint to retrieve your user information.
    curl --request GET \
  --url https://api.frame.io/v2/me \
  --header 'authorization: Bearer <DEV_TOKEN>'

  4. Develop Asset Management and OAuth2.0 Applications

    Core development building blocks for Frame.io include:

    • Reading Directory Lists: Navigating the project structure starting from the root folder to locate destinations.
    • Uploading Assets: Adding media files to specific projects.
    • OAuth2.0 Applications: Building applications intended for distribution to multiple users.

  5. Implement Camera to Cloud (C2C) integrations

    Camera to Cloud (C2C) integrations are specifically designed for devices or applications that generate data. Developers building C2C integrations should follow the dedicated C2C Integration guides rather than the general platform API guides.

  6. Use Frame.io Official Python SDK and CLI

    Frame.io provides an official Python SDK to simplify API integration by abstracting pagination and rate limiting. Additionally, a command-line interface called FIOCTL is available for performing Frame.io operations from the terminal. Both are available via PyPI.
    pip install frameio-sdk
# Or for the CLI
pip install fioctl