Version an Asset | Frame.io API Documentation

import requests
url = "https://api.frame.io/v2/assets/asset_id/version"
payload = { "next_asset_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "account_id": "7b9f1c2e-4d3a-4f8b-9a1e-2d5f6a7b8c9d",
  "archive_from": "2024-01-15T09:30:00Z",
  "archive_scheduled_at": "2024-01-15T09:30:00Z",
  "archive_status": "scheduled",
  "archived_at": "2024-01-15T09:30:00Z",
  "asset_type": "document",
  "bundle": true,
  "bundle_view": "detailed",
  "cover_asset_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "creator": {
    "digest_frequency": "weekly",
    "image_32": "https://cdn.frame.io/images/users/32/user123.png",
    "image_128": "https://cdn.frame.io/images/users/128/user123.png",
    "from_google": true,
    "mfa_enforced_at": "2023-12-01T08:00:00Z",
    "email": "jane.doe@example.com",
    "name": "Jane Doe",
    "image_64": "https://cdn.frame.io/images/users/64/user123.png",
    "timezone_value": "America/New_York",
    "account_id": "7b9f1c2e-4d3a-4f8b-9a1e-2d5f6a7b8c9d",
    "updated_at": "2024-04-10T12:00:00Z",
    "image_256": "https://cdn.frame.io/images/users/256/user123.png",
    "_type": "user",
    "user_hash": "abc123def456ghi789",
    "upload_url": "https://upload.frame.io/user123",
    "profile_image": "https://cdn.frame.io/images/users/profile/user123.png",
    "first_login_at": "2022-05-15T09:00:00Z",
    "joined_via": "google_oauth",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "next_digest_date": "2024-04-20T09:00:00Z",
    "last_seen": "2024-04-15T18:30:00Z",
    "inserted_at": "2022-05-15T09:00:00Z",
    "from_adobe": true,
    "avatar_color": "#4A90E2",
    "highest_account_role": "admin",
    "integrations": [
      "slack",
      "dropbox"
    ],
    "roles": {
      "admin": true,
      "id": "role-1234",
      "sales": true,
      "support": true,
      "service_desk": false
    },
    "user_default_color": "#FF5733"
  },
  "frames": 2400,
  "hard_deleted_at": "2024-02-14T09:30:00Z",
  "id": "9f8e7d6c-5b4a-3c2d-1e0f-9a8b7c6d5e4f",
  "index": 12.5,
  "is_bundle_child": false,
  "is_hls_required": true,
  "is_session_watermarked": true,
  "item_count": 5,
  "label": "approved",
  "metadata": {},
  "metadata_flags": {
    "id": "4c3b2a19-8d7e-6f5a-4b3c-2d1e0f9a8b7c",
    "is_360": false,
    "is_hdr": true,
    "is_original_player_compatible": true
  },
  "name": "Project Proposal Document.pdf",
  "original": "https://cdn.frame.io/assets/9f8e7d6c-5b4a-3c2d-1e0f-9a8b7c6d5e4f/original.pdf",
  "parent_asset_id": "2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
  "project_id": "5d6e7f8a-9b0c-1d2e-3f4a-5b6c7d8e9f0a",
  "properties": {
    "": "Confidential"
  },
  "required_transcodes": {
    "cover": true,
    "finalized": [
      "thumb",
      "image_full",
      "h264_720"
    ],
    "h264_1080_best": true,
    "h264_2160": false,
    "h264_360": true,
    "h264_540": true,
    "h264_720": true,
    "image_full": true,
    "image_high": true,
    "page_proxy": true,
    "thumb": true,
    "thumb_540": false,
    "thumb_orig_ar_540": false,
    "thumb_scrub": true
  },
  "team_id": "8a9b0c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d",
  "user_permissions": {
    "can_download": true,
    "can_modify_template": false,
    "can_public_share_presentation": true,
    "can_public_share_review_link": true,
    "can_share_downloadable_presentation": false,
    "can_share_downloadable_review_link": true,
    "can_share_unwatermarked_presentation": false,
    "can_share_unwatermarked_review_link": true
  },
  "type": "file",
  "view_count": 152
}

Add an asset to a version stack, or create one if one doesn't already exist

Authentication

AuthorizationBearer

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

Path parameters

asset_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

next_asset_idstringRequiredformat: "uuid"

Response headers

x-ratelimit-limitdouble

The number of times you can make this call within the x-ratelimit-window

x-ratelimit-windowstring

The length in milliseconds of the rate limit window

x-ratelimit-remainingstring

The number of remaining times you can make this API call in the x-ratelimit-window

Response

Asset success response

object

Errors

401

Unauthorized Error

404

Not Found Error

1	import requests
2
3	url = "https://api.frame.io/v2/assets/asset_id/version"
4
5	payload = { "next_asset_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }
6	headers = {
7	"Authorization": "Bearer <token>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"account_id": "7b9f1c2e-4d3a-4f8b-9a1e-2d5f6a7b8c9d",
3	"archive_from": "2024-01-15T09:30:00Z",
4	"archive_scheduled_at": "2024-01-15T09:30:00Z",
5	"archive_status": "scheduled",
6	"archived_at": "2024-01-15T09:30:00Z",
7	"asset_type": "document",
8	"bundle": true,
9	"bundle_view": "detailed",
10	"cover_asset_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
11	"creator": {
12	"digest_frequency": "weekly",
13	"image_32": "https://cdn.frame.io/images/users/32/user123.png",
14	"image_128": "https://cdn.frame.io/images/users/128/user123.png",
15	"from_google": true,
16	"mfa_enforced_at": "2023-12-01T08:00:00Z",
17	"email": "jane.doe@example.com",
18	"name": "Jane Doe",
19	"image_64": "https://cdn.frame.io/images/users/64/user123.png",
20	"timezone_value": "America/New_York",
21	"account_id": "7b9f1c2e-4d3a-4f8b-9a1e-2d5f6a7b8c9d",
22	"updated_at": "2024-04-10T12:00:00Z",
23	"image_256": "https://cdn.frame.io/images/users/256/user123.png",
24	"_type": "user",
25	"user_hash": "abc123def456ghi789",
26	"upload_url": "https://upload.frame.io/user123",
27	"profile_image": "https://cdn.frame.io/images/users/profile/user123.png",
28	"first_login_at": "2022-05-15T09:00:00Z",
29	"joined_via": "google_oauth",
30	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
31	"next_digest_date": "2024-04-20T09:00:00Z",
32	"last_seen": "2024-04-15T18:30:00Z",
33	"inserted_at": "2022-05-15T09:00:00Z",
34	"from_adobe": true,
35	"avatar_color": "#4A90E2",
36	"highest_account_role": "admin",
37	"integrations": [
38	"slack",
39	"dropbox"
40	],
41	"roles": {
42	"admin": true,
43	"id": "role-1234",
44	"sales": true,
45	"support": true,
46	"service_desk": false
47	},
48	"user_default_color": "#FF5733"
49	},
50	"frames": 2400,
51	"hard_deleted_at": "2024-02-14T09:30:00Z",
52	"id": "9f8e7d6c-5b4a-3c2d-1e0f-9a8b7c6d5e4f",
53	"index": 12.5,
54	"is_bundle_child": false,
55	"is_hls_required": true,
56	"is_session_watermarked": true,
57	"item_count": 5,
58	"label": "approved",
59	"metadata": {},
60	"metadata_flags": {
61	"id": "4c3b2a19-8d7e-6f5a-4b3c-2d1e0f9a8b7c",
62	"is_360": false,
63	"is_hdr": true,
64	"is_original_player_compatible": true
65	},
66	"name": "Project Proposal Document.pdf",
67	"original": "https://cdn.frame.io/assets/9f8e7d6c-5b4a-3c2d-1e0f-9a8b7c6d5e4f/original.pdf",
68	"parent_asset_id": "2a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
69	"project_id": "5d6e7f8a-9b0c-1d2e-3f4a-5b6c7d8e9f0a",
70	"properties": {
71	"": "Confidential"
72	},
73	"required_transcodes": {
74	"cover": true,
75	"finalized": [
76	"thumb",
77	"image_full",
78	"h264_720"
79	],
80	"h264_1080_best": true,
81	"h264_2160": false,
82	"h264_360": true,
83	"h264_540": true,
84	"h264_720": true,
85	"image_full": true,
86	"image_high": true,
87	"page_proxy": true,
88	"thumb": true,
89	"thumb_540": false,
90	"thumb_orig_ar_540": false,
91	"thumb_scrub": true
92	},
93	"team_id": "8a9b0c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d",
94	"user_permissions": {
95	"can_download": true,
96	"can_modify_template": false,
97	"can_public_share_presentation": true,
98	"can_public_share_review_link": true,
99	"can_share_downloadable_presentation": false,
100	"can_share_downloadable_review_link": true,
101	"can_share_unwatermarked_presentation": false,
102	"can_share_unwatermarked_review_link": true
103	},
104	"type": "file",
105	"view_count": 152
106	}