Connect device

Deprecated

POST

https://api.frame.io/v2/devices/connect

POST

/v2/devices/connect

1 import requests
2 
3 url = "https://api.frame.io/v2/devices/connect"
4 
5 headers = {"Authorization": "Bearer <token>"}
6 
7 response = requests.post(url, headers=headers)
8 
9 print(response.json())

204No Content

1 {
2   "_type": "project_device",
3   "id": "string",
4   "asset_type": "string",
5   "creator_id": "string",
6   "deleted_at": "2021-08-03T00:00:00Z",
7   "device_id": "string",
8   "inserted_at": "2021-08-03T00:00:00Z",
9   "last_seen_at": "2021-08-03T00:00:00Z",
10   "last_known_firmware_version": "string",
11   "name": "string",
12   "project_id": "string",
13   "updated_at": "string",
14   "status": "offline",
15   "timezone": "string",
16   "authorization": {
17     "_type": "project_device_authorization",
18     "creator": {
19       "_type": "user",
20       "id": "string",
21       "name": "string"
22     },
23     "creator_id": "string",
24     "id": "string",
25     "inserted_at": "2024-01-15T09:30:00Z",
26     "project_device_id": "string",
27     "scopes": {
28       "account_read": true,
29       "action_create": true,
30       "action_delete": true,
31       "action_read": true,
32       "action_update": true,
33       "asset_create": true,
34       "asset_delete": true,
35       "asset_read": true,
36       "asset_update": true,
37       "auditlog_read": true,
38       "comment_create": true,
39       "comment_delete": true,
40       "comment_read": true,
41       "comment_update": true,
42       "device_connect": true,
43       "id": "string",
44       "offline": true,
45       "presentation_create": true,
46       "presentation_delete": true,
47       "presentation_read": true,
48       "presentation_update": true,
49       "project_create": true,
50       "project_delete": true,
51       "project_read": true,
52       "project_update": true,
53       "reviewlink_create": true,
54       "reviewlink_delete": true,
55       "reviewlink_read": true,
56       "reviewlink_update": true,
57       "team_create": true,
58       "team_read": true,
59       "team_update": true,
60       "webhook_create": true,
61       "webhook_delete": true,
62       "webhook_read": true,
63       "webhook_update": true
64     },
65     "expires_at": "2024-01-15T09:30:00Z"
66   },
67   "project": {
68     "archive_status": "standard",
69     "archived_at": "2024-01-15T09:30:00Z",
70     "archived_file_count": 0,
71     "archived_storage": 0,
72     "collaborator_count": 0,
73     "deleted_at": "2024-01-15T09:30:00Z",
74     "description": "string",
75     "file_count": 0,
76     "folder_count": 0,
77     "id": "string",
78     "ignore_archive": false,
79     "inserted_at": "2024-01-15T09:30:00Z",
80     "invite_url": "string",
81     "name": "string",
82     "owner_id": "string",
83     "private": false,
84     "project_preferences": {
85       "collaborator_can_download": true,
86       "collaborator_can_invite": true,
87       "collaborator_can_share": true,
88       "notify_on_new_asset": true,
89       "notify_on_new_collaborator": true,
90       "notify_on_new_comment": true,
91       "notify_on_updated_label": true,
92       "notify_slack": true
93     },
94     "read_only": false,
95     "root_asset": {
96       "account_id": "string",
97       "archive_from": "2024-01-15T09:30:00Z",
98       "archive_scheduled_at": "2024-01-15T09:30:00Z",
99       "archive_status": "string",
100       "archived_at": "2024-01-15T09:30:00Z",
101       "asset_type": "document",
102       "bundle": true,
103       "bundle_view": "string",
104       "cover_asset_id": "string",
105       "creator": {
106         "digest_frequency": "string",
107         "image_32": "string",
108         "image_128": "string",
109         "from_google": true,
110         "mfa_enforced_at": "string",
111         "email": "string",
112         "name": "string",
113         "image_64": "string",
114         "timezone_value": "string",
115         "account_id": "string",
116         "updated_at": "string",
117         "image_256": "string",
118         "_type": "string",
119         "user_hash": "string",
120         "upload_url": "string",
121         "profile_image": "string",
122         "first_login_at": "string",
123         "joined_via": "string",
124         "id": "string",
125         "next_digest_date": "string",
126         "last_seen": "string",
127         "inserted_at": "string",
128         "from_adobe": true,
129         "avatar_color": "string",
130         "highest_account_role": "string",
131         "integrations": [
132           "string"
133         ],
134         "roles": {
135           "admin": true,
136           "id": "string",
137           "sales": true,
138           "support": true,
139           "service_desk": true
140         },
141         "user_default_color": "string"
142       },
143       "frames": 1,
144       "hard_deleted_at": "2024-01-15T09:30:00Z",
145       "id": "string",
146       "index": 1.1,
147       "is_bundle_child": true,
148       "is_hls_required": true,
149       "is_session_watermarked": true,
150       "item_count": 1,
151       "label": "string",
152       "metadata": {},
153       "metadata_flags": {
154         "id": "string",
155         "is_360": true,
156         "is_hdr": true,
157         "is_original_player_compatible": true
158       },
159       "name": "string",
160       "original": "string",
161       "parent_asset_id": "string",
162       "project_id": "string",
163       "properties": {
164         "": "string"
165       },
166       "required_transcodes": {
167         "cover": true,
168         "finalized": [
169           "thumb"
170         ],
171         "h264_1080_best": true,
172         "h264_2160": true,
173         "h264_360": true,
174         "h264_540": true,
175         "h264_720": true,
176         "image_full": true,
177         "image_high": true,
178         "page_proxy": true,
179         "thumb": true,
180         "thumb_540": true,
181         "thumb_orig_ar_540": true,
182         "thumb_scrub": true
183       },
184       "team_id": "string",
185       "user_permissions": {
186         "can_download": true,
187         "can_modify_template": true,
188         "can_public_share_presentation": true,
189         "can_public_share_review_link": true,
190         "can_share_downloadable_presentation": true,
191         "can_share_downloadable_review_link": true,
192         "can_share_unwatermarked_presentation": true,
193         "can_share_unwatermarked_review_link": true
194       },
195       "type": "file",
196       "view_count": 1
197     },
198     "root_asset_id": "string",
199     "shared": false,
200     "storage": 0,
201     "team": {
202       "account_id": "string",
203       "disable_sbwm_internally": false,
204       "creator_id": "string",
205       "storage": 0,
206       "default_font_color": "string",
207       "access": "private",
208       "font_color": "string",
209       "user_role": {},
210       "file_count": 0,
211       "default_session_watermark_template": {
212         "account_id": "string",
213         "app_default": false,
214         "creator_id": "string",
215         "id": "string",
216         "name": "string",
217         "watermark_blocks": [
218           {
219             "alpha": 0.5,
220             "data_points": [
221               {
222                 "order": 1,
223                 "type": "email",
224                 "value": "string"
225               }
226             ],
227             "font_size": "medium",
228             "name": "string",
229             "position": "top_left",
230             "position_reference_point": "top_left",
231             "position_x": 1,
232             "position_y": 1,
233             "scroll_text": "none",
234             "text_alignment": "left",
235             "text_color": "#FFFFFF",
236             "text_shadow": false
237           }
238         ]
239       },
240       "link": "string",
241       "asset_lifecycle_policy": 1,
242       "upload_url": "string",
243       "admin_only_actions": {
244         "lifecycle": false
245       },
246       "deleted_at": "2024-01-15T09:30:00Z",
247       "default_background_color": "string",
248       "storage_limit": 1,
249       "location": "string",
250       "name": "string",
251       "default_color": "string",
252       "slack_webhook": {},
253       "image_64": "string",
254       "archived_storage": 0,
255       "image_128": "string",
256       "solo": false,
257       "account": {
258         "invoice_emails": [
259           "string"
260         ],
261         "city": "string",
262         "account_default_color": "string",
263         "company_name": "string",
264         "storage": 1,
265         "file_count": 1,
266         "owner": {
267           "digest_frequency": "string",
268           "image_32": "string",
269           "image_128": "string",
270           "from_google": true,
271           "mfa_enforced_at": "string",
272           "email": "string",
273           "name": "string",
274           "image_64": "string",
275           "timezone_value": "string",
276           "account_id": "string",
277           "updated_at": "string",
278           "image_256": "string",
279           "_type": "string",
280           "user_hash": "string",
281           "upload_url": "string",
282           "profile_image": "string",
283           "first_login_at": "string",
284           "joined_via": "string",
285           "id": "string",
286           "next_digest_date": "string",
287           "last_seen": "string",
288           "inserted_at": "string",
289           "from_adobe": true,
290           "avatar_color": "string",
291           "highest_account_role": "string",
292           "integrations": [
293             "string"
294           ],
295           "roles": {
296             "admin": true,
297             "id": "string",
298             "sales": true,
299             "support": true,
300             "service_desk": true
301           },
302           "user_default_color": "string"
303         },
304         "upload_url": "string",
305         "deleted_at": "2024-01-15T09:30:00Z",
306         "line1": "string",
307         "postal_code": "string",
308         "vat": "string",
309         "company_address": "string",
310         "lifetime_file_count": 1,
311         "state": "string",
312         "teams": [
313           null
314         ],
315         "image_64": "string",
316         "archived_storage": 1,
317         "image_128": "string",
318         "owner_id": "string",
319         "user_count": 1,
320         "locked_at": "2024-01-15T09:30:00Z",
321         "image": "string",
322         "team_count": 1,
323         "collaborator_role_count": 1,
324         "billing_emails": "string",
325         "image_32": "string",
326         "unpaid_at": "2024-01-15T09:30:00Z",
327         "inserted_at": "2024-01-15T09:30:00Z",
328         "updated_at": "2024-01-15T09:30:00Z",
329         "project_count": 1,
330         "duration": 1,
331         "delinquent_at": "2024-01-15T09:30:00Z",
332         "collaborator_count": 1,
333         "plan": {
334           "archived_storage_limit": 1,
335           "autoscaling": true,
336           "available_features": {
337             "archival_storage": true,
338             "custom_branded_emails": true,
339             "custom_branded_presentations": true,
340             "reel_player": true,
341             "secure_sharing": true,
342             "session_based_watermarking": true,
343             "team_only_comments": true
344           },
345           "collaborator_limit": 1,
346           "cost": 1,
347           "default_plan": true,
348           "deleted_at": "2024-01-15T09:30:00Z",
349           "enterprise": true,
350           "file_limit": 1,
351           "id": "string",
352           "inserted_at": "2024-01-15T09:30:00Z",
353           "lifetime_file_limit": 1,
354           "member_limit": 1,
355           "name": "string",
356           "payment_method": "stripe",
357           "period": "monthly",
358           "project_limit": 1,
359           "storage_limit": 1,
360           "team_limit": 1,
361           "tier": "free",
362           "title": "string",
363           "updated_at": "2024-01-15T09:30:00Z",
364           "user_limit": 1,
365           "user_max": 1,
366           "version": 1
367         },
368         "watermark": {
369           "image": {
370             "alpha": 0.5,
371             "image": {
372               "bucket": "string",
373               "key": "string",
374               "type": "image/jpeg",
375               "uploaded": false
376             },
377             "position": "top_left"
378           },
379           "text": {
380             "alpha": 0.5,
381             "lines": [
382               "string"
383             ],
384             "position": "top"
385           }
386         },
387         "folder_count": 1,
388         "id": "string",
389         "display_name": "string",
390         "country": "string",
391         "subscription": {
392           "account_id": "string",
393           "archived_storage_limit": 1,
394           "balance": 1,
395           "cancellation_option": "string",
396           "cancellation_reason": "string",
397           "cancelled_at": "2024-01-15T09:30:00Z",
398           "deleted_at": "2024-01-15T09:30:00Z",
399           "id": "string",
400           "inserted_at": "2024-01-15T09:30:00Z",
401           "last_payment_at": "2024-01-15T09:30:00Z",
402           "member_limit": 1,
403           "next_bill_at": "2024-01-15T09:30:00Z",
404           "on_trial": true,
405           "plan": {
406             "archived_storage_limit": 1,
407             "autoscaling": true,
408             "available_features": {
409               "archival_storage": true,
410               "custom_branded_emails": true,
411               "custom_branded_presentations": true,
412               "reel_player": true,
413               "secure_sharing": true,
414               "session_based_watermarking": true,
415               "team_only_comments": true
416             },
417             "collaborator_limit": 1,
418             "cost": 1,
419             "default_plan": true,
420             "deleted_at": "2024-01-15T09:30:00Z",
421             "enterprise": true,
422             "file_limit": 1,
423             "id": "string",
424             "inserted_at": "2024-01-15T09:30:00Z",
425             "lifetime_file_limit": 1,
426             "member_limit": 1,
427             "name": "string",
428             "payment_method": "stripe",
429             "period": "monthly",
430             "project_limit": 1,
431             "storage_limit": 1,
432             "team_limit": 1,
433             "tier": "free",
434             "title": "string",
435             "updated_at": "2024-01-15T09:30:00Z",
436             "user_limit": 1,
437             "user_max": 1,
438             "version": 1
439           },
440           "plan_id": "string",
441           "promotion_expires_at": "2024-01-15T09:30:00Z",
442           "promotion_id": "string",
443           "requires_autoscaling": true,
444           "storage_limit": 1,
445           "subscription_end_at": "2024-01-15T09:30:00Z",
446           "total_archived_storage_limit": 1,
447           "total_lifetime_file_limit": 1,
448           "total_member_limit": 1,
449           "total_project_limit": 1,
450           "total_storage_limit": 1,
451           "total_user_limit": 1,
452           "updated_at": "2024-01-15T09:30:00Z",
453           "user_limit": 1
454         },
455         "account_members": [
456           {
457             "accepted_at": "2024-01-15T09:30:00Z",
458             "account_id": "string",
459             "declined_at": "2024-01-15T09:30:00Z",
460             "deleted_at": "2024-01-15T09:30:00Z",
461             "inserted_at": "2024-01-15T09:30:00Z",
462             "role": "admin",
463             "updated_at": "2024-01-15T09:30:00Z",
464             "user_id": "string"
465           }
466         ],
467         "frames": 1,
468         "member_count": 1,
469         "image_256": "string"
470       },
471       "image_32": "string",
472       "inserted_at": "2024-01-15T09:30:00Z",
473       "updated_at": "2024-01-15T09:30:00Z",
474       "project_count": 0,
475       "duration": 0,
476       "team_image": "string",
477       "collaborator_count": 0,
478       "bio": "string",
479       "color": "string",
480       "email_branding": {
481         "accent_color": "string",
482         "background_color": "string",
483         "image": {
484           "bucket": "string",
485           "key": "string",
486           "type": "image/jpeg",
487           "uploaded": false
488         }
489       },
490       "folder_count": 0,
491       "dark_theme": false,
492       "default_session_watermark_template_id": "string",
493       "session_watermark_templates": [
494         {
495           "account_id": "string",
496           "app_default": false,
497           "creator_id": "string",
498           "id": "string",
499           "name": "string",
500           "watermark_blocks": [
501             {
502               "alpha": 0.5,
503               "data_points": [
504                 {
505                   "order": 1,
506                   "type": "email",
507                   "value": "string"
508                 }
509               ],
510               "font_size": "medium",
511               "name": "string",
512               "position": "top_left",
513               "position_reference_point": "top_left",
514               "position_x": 1,
515               "position_y": 1,
516               "scroll_text": "none",
517               "text_alignment": "left",
518               "text_color": "#FFFFFF",
519               "text_shadow": false
520             }
521           ]
522         }
523       ],
524       "id": "string",
525       "member_limit": 1,
526       "frames": 0,
527       "member_count": 0,
528       "image_256": "string",
529       "background_color": "string"
530     },
531     "team_id": "string",
532     "updated_at": "2024-01-15T09:30:00Z",
533     "user_permissions": {
534       "can_download": true,
535       "can_modify_template": true,
536       "can_public_share_presentation": true,
537       "can_public_share_review_link": true,
538       "can_share_downloadable_presentation": true,
539       "can_share_downloadable_review_link": true,
540       "can_share_unwatermarked_presentation": true,
541       "can_share_unwatermarked_review_link": true
542     },
543     "user_preferences": {
544       "collaborator_can_download": true,
545       "collaborator_can_invite": true,
546       "collaborator_can_share": true,
547       "notify_on_new_asset": true,
548       "notify_on_new_collaborator": true,
549       "notify_on_new_comment": true,
550       "notify_on_updated_label": true,
551       "notify_slack": true
552     },
553     "watermark": {
554       "image": {
555         "alpha": 0.5,
556         "image": {
557           "bucket": "string",
558           "key": "string",
559           "type": "image/jpeg",
560           "uploaded": false
561         },
562         "position": "top_left"
563       },
564       "text": {
565         "alpha": 0.5,
566         "lines": [
567           "string"
568         ],
569         "position": "top"
570       }
571     }
572   },
573   "channels": [
574     {
575       "_type": "project_device_channel",
576       "id": "string",
577       "actor_id": "string",
578       "asset_type": "audio",
579       "device_id": "string",
580       "external_index": 1.1,
581       "inserted_at": "2021-08-03T00:00:00Z",
582       "name": "string",
583       "project_id": "string",
584       "project_device_id": "string",
585       "real_time_logging_capable": false,
586       "status": "offline",
587       "updated_at": "2021-08-03T00:00:00Z"
588     }
589   ],
590   "channel_count": 1,
591   "path_asset_type": "string",
592   "path_name": "string",
593   "required_metadata_attributes": [
594     "string"
595   ]
596 }

Connect to the provided C2C Project.

認証

AuthorizationBearer

Bearer <token>形式のBearer認証。tokenは認証トークンです。

クエリパラメータ

project_idstringオプション

The project_id you intend to connect to

レスポンス

Succesful response after identifying the device.

_typestringデフォルト値 project_device

Resource type identifier

idstring形式: "uuid"

asset_typestring

The type of asset that this device will be producing

creator_idstring形式: "uuid"

deleted_atstring形式: "date-time"

device_idstring形式: "uuid"

inserted_atstring形式: "date-time"

last_seen_atstring形式: "date-time"

last_known_firmware_versionstring

The last known firmware version reported by the device

namestring<=255 characters

Name of this device as shown in the iOS app and web app

project_idstring形式: "uuid"

The Project ID that this device is linked to

updated_atstring

statusenum

許可された値:

timezonestring

authorizationobject

Authorization details for a project device

projectobject

channelslist of objects

channel_countinteger<=100

path_asset_typestring<=50 characters

path_namestring<=50 characters

required_metadata_attributeslist of strings

Connect device

認証

ヘッダー

クエリパラメータ

レスポンス

認証

ヘッダー

クエリパラメータ

レスポンス