Create Space From Frame IO API

Changed on

Overview

The Substance 3D API provides a way to upload and temporary store files. You can upload folders from frame.io to create a space. To upload a folder from frame.io, you must pass the following parameters:

  • access Token
  • folder ID

The result of the post is a JSON which contained the id of the space created.
Space id can be used into a space source to use space content as a source for API operations.

Example of a space source:

{
  "space": {
    "id": "<space_id>"
  }
}
post/v2/spacesFrameIO

Request

  • Base URL: https://s3d.adobe.io
  • URL: https://s3d.adobe.io/v2/spacesFrameIO
  • Auth: HTTP bearer and API key in header x-api-key

Request body

$schemastring uri

A URL to the JSON Schema for this object.

accessTokenstring required

Frame.io access token or Developer token. See https://developer.frame.io/docs/getting-started/authentication for obtaining a token.

folderIdstring required

Frame.io folder ID containing the assets. This should be the ID of the folder (not an asset ID). For best performance and to avoid size limitations, use the folder ID closest to your target assets. The system will retrieve all content from the specified folder, so choosing a parent folder with many subfolders may exceed the maximum retrieval size limit

Example request

{
  "$schema": "https://s3d.adobe.io/schemas/rest_base.FileFrameIO.json",
  "accessToken": "base64.jwt.token",
  "folderId": "01234567-89ab-cdef-0123-456789abcdef"
}

Response

Created

$schemastring uri

A URL to the JSON schema for this object.

expirystring date-time required

time at which the space will be deleted

idstring required

Unique identifier of this Space.

urlstring required

URL to the full description of this Space.

archiveUrlunknown

Example response

{
  "$schema": "https://s3d.adobe.io/schemas/rest_base.Space.json"
}

Changes