> This page is for 平台, version 旧版.
> For other versions, use one of these documentation indexes:
> - V4 (default): https://next.developer.frame.io/platform/v4/llms.txt
> - V4 实验版: https://next.developer.frame.io/platform/v4-experimental/llms.txt
> - 旧版: https://next.developer.frame.io/platform/v2/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://next.developer.frame.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://next.developer.frame.io/_mcp/server.

# 欢迎

<Error title="需要迁移平台 API">
  **V2 API 已弃用。**新增功能和改进功能仅在 V4 中提供。[查看指南](/platform/v2/docs/migration/v-2-to-v-4-migration-guide)。
</Error>


## 关于 Frame.io

[Frame.io](https://frame.io) 是面向专业视频团队的云协作工具——您需要的一切，都集中在一个工作台中，随时随地均可访问，从而让创意流程持续推进。通过 Frame.io，您可以安全地上传、共享和审阅影视项目，让整个工作流以创意的速度运转。

### Frame.io Developer Platform




并非每个创意团队、流程或软件堆栈都完全相同。这就是我们 Developer Platform 的用武之地。Frame.io Developer Platform 允许您使用我们的 API 处理常见任务。开发者利用我们的 API 实现的一些常见用例包括：自动将现有文件或文件夹添加到 Frame.io 应用程序、上传新内容以及管理团队。





## Camera to Cloud (C2C) 计划

Camera to Cloud 是一种独特的集成类型。这些集成专为任何生成数据的设备或应用程序而构建。如果您正在构建 C2C 集成，那么您将需要用到 [C2C 集成指南](/device-integrations/getting-started-with-cloud-device-integrations)。在该指南中，您可以找到开始使用 Frame.io 连接到云端所需的所有信息！

## Frame.io 官方 SDK



<CardGroup cols={2}>
  
  
<Card icon="brands python" href="https://github.com/Frameio/python-frameio-client" title="Python SDK">
  
    

Frame.io 用于 API 集成的官方 Python SDK


  
</Card>

<Card icon="terminal" href="https://github.com/Frameio/fioctl" title="Python CLI">
  
    

Frame.io 操作的命令行界面


  
</Card>

</CardGroup>
 Frame.io 提供了一个 Python 版本的 SDK，让您可以更轻松地开始使用我们的 API，包括对分页和速率限制等关键概念进行了抽象处理。该项目已在 PyPI 上可用，因此 `pip install` 即可开始使用！如果您更倾向于使用命令行，FIOCTL 也同样可以在 PyPI 上获取。

## 快速入门指南




如果您想立即开始使用，只需点击此按钮，将我们的 API 导入 Postman 即可！

[<img alt="在 Postman 中运行" src="https://run.pstmn.io/button.svg" />](https://www.getpostman.com/collections/c2dfffb88990a9dc34c2)

否则，请继续阅读下面的内容。首先，您需要确保拥有一个可以登录的 Frame.io 帐户。





接下来：



* 使用您的 Frame.io 凭据[登录开发者门户](/)
* [创建一个开发者令牌](/getting-started/authentication#developer-tokens)




为了确认您的令牌正常工作，请使用您选择的语言、工具或代理发起一次测试调用：




<CodeBlocks>
  


**`cURL`**

```bash title="cURL"
curl --request GET \
  --url https://api.frame.io/v2/me \
  --header 'authorization: Bearer <DEV_TOKEN>'
```





**`Python`**

```python title="Python"
import requests

url = "https://api.frame.io/v2/me"
headers = {
 "Authorization": "Bearer <DEV_TOKEN>"
}

requests.GET(url,headers=headers)
```



</CodeBlocks>


作为响应，您应该能够看到自己的用户信息。





## 构建模块




大多数与 Frame.io 集成的工作流都将专注于媒体资产上传和检索。如果您计划在您的组织内部（或外部！）构建一个完整的应用程序用于发布，您可能还需要考虑构建一个用于分发的 OAuth2.0 应用程序。以下指南是您开启集成之旅所需的主要构建模块：




<CardGroup cols={3}>
  
  
<Card href="/workflows-assets/reading-the-file-tree" title="读取目录列表">
  
    

导航 Frame.io 的项目结构


  
</Card>

<Card href="/workflows-assets/uploading-assets" title="上传资产">
  
    

将媒体文件添加到您的 Frame.io 项目


  
</Card>

<Card href="/oauth-2-applications/building-an-oauth2-app" title="构建 OAuth2.0 应用程序">
  
    

为多位用户创建应用程序


  
</Card>

</CardGroup>


所有资产都存放在项目中。第一份指南涵盖项目遍历，从根文件夹开始。一旦您可以导航到特定目标位置，您就具备了开始上传媒体文件所需的一切条件。在上传功能可以正常运行之后，便可以构建一个供其他人使用的应用程序了！





## 基于事件的工作流




Frame.io Developer Platform 提供了几个选项，您可以用来将工作流扩展到其他工具中，或者创建全新的功能。





### Webhook




Webhook 提供了一种方式，可以将 Frame.io 内部发生的事件转化为通知，这些通知可以发送到外部系统进行处理、作为 API 回调，并实现工作流自动化。

可以通过多种方式使用我们的 Webhook。您可以自己构建某些功能，也可以利用无代码自动化工具，如 [Zapier](https://zapier.com)、[Integromat](https://www.integromat.com)、[Pabbly Connect](https://www.pabbly.com/) 或 [Pipedream](https://pipedream.com)。
* [Webhook](/automations-webhooks/webhooks-overview) - Webhook 将 Frame.io 事件暴露给外部 URL，以便使用和处理。
* [Zapier](/zapier/get-started-with-zapier) - 一款在线自动化工具，让您无需编写代码就能连接 1,000 多个常用应用程序和工具。

我们在 Github 上有一个 [Webhook 示例应用程序](https://github.com/Frameio/webhooks-example-app)，如果您想构建自己的接收器，可以将其作为起点。

### 自定义操作

[自定义操作](/custom-actions/custom-actions-overview)让您以可编程 UI 组件的形式将集成直接构建到 Frame.io 中。从技术上讲，它们与 Webhook 非常相似，并且是扩展 Frame.io 工作流的绝佳方式。

## 加入开发者社区

如果您还不确定是否要立即开始构建，可以先看看我们的[开发者论坛](https://forum.frame.io)。我们的社区汇聚了众多开发者、技术爱好者和创意专业人士，他们利用 Frame.io 的 API 结合各种其他工作流工具，已经构建或正在构建出色的集成。