Create C2C asset

Asset upload initiation specifically for C2C devices and applications

SecurityC2CDeviceAuth or C2COAuth2
Request
Request Body schema:

While supported, we encourage you to switch from application/x-ww-form-urlencoded to application/json in order to support future workflows that will only be supported through JSON.

name
string

The name the asset should have in Frame.io. This value does not have to match the name of the file on disk; it can be whatever you want it to be in Frame.io.

filetype
string

This should be a MIME type like video/quicktime. Many languages have built in utilities for detecting file mimetype (see Go and Python for examples).

auto_version_id
string <uuid>

The asset you'd like this to be the next version of

string or integer

File size in bytes

string or integer
string or integer

The number of seconds since the file was created. Defaults to 0 if not set. Although the offset parameter is technically optional, we will require that integrations supply it. Offset is how we handle detecting when a file should be rejected due to a device being paused. We will go over the importance of the offset parameter in the advanced uploading guide.

string or integer

Number of parts you'd like to upload your file in (you'll get 1 URL for each part).

Responses
200

Asset success response

Response Headers
x-ratelimit-limit
number

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

x-ratelimit-window
string

The length in milliseconds of the rate limit window

x-ratelimit-remaining
string

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

Response Schema: application/json
account_id
string <uuid>

Account ID this asset belongs to

asset_type
string
Enum: "document" "image" "stream"
archive_from
string or null <date-time>
bundle
boolean
Deprecated
bundle_view
string
Deprecated
cover_asset_id
string <uuid>
object (User)

User model

frames
integer

The number of frames in this asset (really only useful for videos)

hard_deleted_at
string or null <date-time>

Indicates the datetime this asset was hard deleted (30 days after soft-deletion)

id
string <uuid>

The ID for this asset, can be used in places like https://app.frame.io/player/:id to go directly to an asset

index
number <float>

Represented within the Frame.io UI as the "custom sort order" within the grid view

is_bundle_child
boolean
Deprecated

Indicates whether an asset is the child of a bundle asset

is_hls_required
boolean

Indicates whether HLS is required to playback this asset

is_session_watermarked
boolean

Indicates if this asset is subject to Session Based Watermarking (WMID)

item_count
integer
string

Will be

metadata
object
object (MetadataFlags)
name
string

Represents the name of the asset (filename)

original
string

This is a URL to download the original asset, or in the event it's subject to watermarking but you still have permission to download - an asset that will be watermarked just-in-time as you download it

project_id
string <uuid>

The project ID that this asset belongs to

object

Accepts arbitrary key/value pairs for storing information on an asset

object (RequiredTranscodes)
team_id
string <uuid>
object (UserPermissions)
type
string
Enum: "file" "folder" "version_stack" "bundle"
view_count
integer

Not a very helpful number, this really just represents the number of times this asset has been requested via the API

409
post/v2/assets
Request samples
{ }
Response samples
application/json
{
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "asset_type": "document",
  • "archive_from": "2019-08-24T14:15:22Z",
  • "bundle": true,
  • "bundle_view": "string",
  • "cover_asset_id": "6bd8f503-67d9-4b55-b7c3-e1b6bef82750",
  • "creator": {
    },
  • "frames": 0,
  • "hard_deleted_at": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "index": 0,
  • "is_bundle_child": true,
  • "is_hls_required": true,
  • "is_session_watermarked": true,
  • "item_count": 0,
  • "label": "approved",
  • "metadata": { },
  • "metadata_flags": {
    },
  • "name": "string",
  • "original": "string",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "properties": {
    },
  • "required_transcodes": {
    },
  • "team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",
  • "user_permissions": {
    },
  • "type": "file",
  • "view_count": 0
}