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.
This checklist outlines the best practices and requirements for joining the C2C ecosystem. While not every item applies to all C2C devices or applications, the C2C Partnerships team will work with you to define specific requirements during the C2C Certification Program.
Basic Integration Requirements
All integrations must include:
User Code
Display a 6-digit code to the user. For web interfaces or QR code-capable devices, use the verification_url_complete to provide users a hyperlink option for logging in and selecting a project to connect to.
Project Display
Shows the connected project name so users can quickly verify their connection without searching through Frame.io’s UI
Upload Status
Clear indicators for:
Remaining file count
Total remaining file size
Current file upload progress
Status of completed, queued, and failed uploads
Network Status
Network connection status display and automatic access token refresh after 8 hours with no user interaction or alerts (unless there’s a refresh error)
Additional requirements:
Cancellable authorization flow at each step
Socket status for real-time communication
Firmware version header in all HTTPS endpoint calls
Security Requirements
At Frame.io, security is paramount. Our requirements include:
HTTPS & Direct Connection
HTTPS-only requests (HTTP requests are rejected)
Direct device/application connection to Frame.io (no intermediary services)
Credential Protection
Protected client_secret and client_id (not user-accessible)
Protected access_token and refresh_token credentials
Encrypted storage of secrets and tokens (optional but recommended)
Uploader Requirements
Reliable media upload is crucial, especially in challenging conditions. Integrations must:
Upload Features
Support automatic uploads either in real-time during recording (preferred) or upon file completion
Show clear upload status, including queue and results
Project name change handling (use project_id instead of name strings)
Quality Assurance
At Frame.io, quality is essential. Key test areas include:
Basic Functionality
Stable launch and operation
Project connection
Hardware code generation
Login/logout capability
Project/user info display
Device management
Asset upload
Format support
Technical Requirements
Upload resumption after interruptions
Progress display
Network status indication
8-hour connection persistence
Cancellable authorization
Direct Frame.io connection
Credential security
Network speed optimization
Future Improvements
The Frame.io Camera to Cloud API evolves continuously. While maintaining backward compatibility, we welcome ongoing dialogue about future developments to keep our API aligned with real-world usage.
That’s all, folks!
Congratulations on completing the UC2CIG (University of C2C Integration Guides)! We hope you found this guide valuable.
Please share any feedback about unclear or missing information, or reach out with C2C-related questions. We’re here to help!
