Create file (remote upload) | Frame.io API Documentation

from frameio import Frameio
from frameio.files import FileCreateRemoteUploadParamsData
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.files.create_remote_upload(
    account_id="118d274a-25a5-4fae-88d1-996569809300",
    folder_id="059bfaa8-a785-4444-aea4-2f67d3a0146d",
    data=FileCreateRemoteUploadParamsData(
        name="asset.png",
        source_url="https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png",
    ),
)

{
  "data": {
    "id": "6a2b33f7-0ba5-412c-b510-124dd112dd45",
    "name": "asset.png",
    "created_at": "2023-09-25T19:18:29.614189Z",
    "parent_id": "827a6d10-1a65-4ec5-87da-a6f3d61b5aff",
    "project_id": "5c1d9036-8def-46fc-bced-1dba86114d48",
    "type": "file",
    "updated_at": "2024-02-07T16:44:41.986478Z",
    "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/view/5a89a9fb-0900-4b23-826b-127b90e4db4c",
    "file_size": 1137444,
    "media_type": "image/png",
    "status": "created"
  },
  "links": {
    "status": "/v4/accounts/fb4dd62f-8a89-4e98-8fa1-ad4b29a0094f/files/eab70952-966c-4d99-949b-f0a947ca5754/status"
  }
}

Create new file under parent folder through remote upload.
Rate Limits: 5 calls per 1 second(s) per account_user

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequiredformat: "uuid"

A UUID String

folder_idstringRequiredformat: "uuid"

A UUID String

Request

Request body

dataobjectRequired

Response headers

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

Response

Accepted

dataobject

linksobject

Link to asset operation status

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

1	from frameio import Frameio
2	from frameio.files import FileCreateRemoteUploadParamsData
3
4	client = Frameio(
5	token="YOUR_TOKEN_HERE",
6	)
7
8	client.files.create_remote_upload(
9	account_id="118d274a-25a5-4fae-88d1-996569809300",
10	folder_id="059bfaa8-a785-4444-aea4-2f67d3a0146d",
11	data=FileCreateRemoteUploadParamsData(
12	name="asset.png",
13	source_url="https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png",
14	),
15	)

1	{
2	"data": {
3	"id": "6a2b33f7-0ba5-412c-b510-124dd112dd45",
4	"name": "asset.png",
5	"created_at": "2023-09-25T19:18:29.614189Z",
6	"parent_id": "827a6d10-1a65-4ec5-87da-a6f3d61b5aff",
7	"project_id": "5c1d9036-8def-46fc-bced-1dba86114d48",
8	"type": "file",
9	"updated_at": "2024-02-07T16:44:41.986478Z",
10	"view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/view/5a89a9fb-0900-4b23-826b-127b90e4db4c",
11	"file_size": 1137444,
12	"media_type": "image/png",
13	"status": "created"
14	},
15	"links": {
16	"status": "/v4/accounts/fb4dd62f-8a89-4e98-8fa1-ad4b29a0094f/files/eab70952-966c-4d99-949b-f0a947ca5754/status"
17	}
18	}