Media

A media object represents a single 360 capture.

Media are created by uploading a zip archive of image frames, these are processed by the DAM which adds additional generated media assets (mp4, gif and resized frames).

List Media

List available Media within the requested Shoot

GEThttps://api.orb360.tech/api/tenant/{tenantId}/shoot/{shootId}/media

Authorization

bearerapi_key

Path parameters

shootId*string

Unique shoot id

tenantId*string

Unique tenant id

Query parameters

Response

200400401404

success

Body

application/json

mediaany

The available media for this shoot

Request

JavaScriptCurl

const response = await fetch('https://api.orb360.tech/api/tenant/{tenantId}/shoot/{shootId}/media', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Get Media

Get an individual media by id

GEThttps://api.orb360.tech/api/tenant/{tenantId}/shoot/{shootId}/media/{mediaId}

Authorization

bearerapi_key

Path parameters

shootId*string

Unique shoot id

tenantId*string

Unique tenant id

mediaId*string

Unique media id

Query parameters

Response

200400401404

success

Body

application/json

mediaall of

The requested media

Request

JavaScriptCurl

const response = await fetch('https://api.orb360.tech/api/tenant/{tenantId}/shoot/{shootId}/media/{mediaId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "media": {
    "mediaId": "daea0774-275b-4e43-9d10-c2f9d5d4d5b6",
    "version": 123,
    "s3path": "boxerTenants/{tenantId}/shoots/{shootId}/daea0774-275b-4e43-9d10-c2f9d5d4d5b6.zip",
    "size": 7511688,
    "shoot": "683606ee-9788-4d88-adb8-77119de4c6a2",
    "mimeType": "application/zip",
    "meta": {
      "boxerTenantId": "fdb67f2e-219d-4771-b14f-a2ddc24b812b",
      "from": "boxer",
      "type": "360_V2",
      "frames": 72,
      "shootId": "683606ee-9788-4d88-adb8-77119de4c6a2"
    },
    "status": "AVAILABLE",
    "processAs": {
      "zip": [
        {
          "type": "text"
        }
      ]
    },
    "originalFilename": "360.zip",
    "generated": {},
    "dateCreated": 1594988393066,
    "dateUpdated": 1594988393066,
    "images": [
      {
        "type": "SINGLE_IMAGE",
        "baseURL": "https://cdn.orb360.tech/image/b1a213d6-8559-45f7-86da-088e6a85d86c/shoots/5b608121-c7b6-4a36-ac2a-54da43d869a2/5dfc5b5e-bc9b-4fde-9af4-e4904ce212a3/",
        "sizes": {
          "ImageWidth": {
            "urls": [
              "800_9fb29dc6a2edc54f2a9851d6bdc23e5df87220fa/5dfc5b5e-bc9b-4fde-9af4-e4904ce212a3-800.jpg?fmt=webp&w=150&s=5c1b7bbeec44a9fa61824b3f6964ece3e419b1fae73855cc97c19b2ea8977ac2"
            ]
          }
        }
      }
    ],
    "eTag": "text",
    "m3u8Index": "text"
  }
}

Create Media

Endpoint

Upload new media to the specified shoot

Requires Admin role on the requested tenant

Using the response from this request, subsequently upload the media payload (zip, jpg or png) to S3.

Perform a POST request to the url property in this response, including all the fields key-values and the file data as a property named file as a multipart-formdata request.

AWS S3 Docs - Uploading objects using presigned URLs

The DAM processor will subsequently validate and perform processing on a successfully uploaded file.

File format

Expected input file formats:

• 360_V2 (default): is a zip file containing JPG image frames in the root of the zip (no folders). The frames must be named with the format img01.jpg, img02.jpg, etc. Frame numbers must be sequential (no gaps).

  Any non-zero number of frames is permitted, but for optimal use the number of frames should be divisible by 4.

  The maximum upload file size for a zip is 800mb.

• SINGLE_IMAGE: is a single JPG or PNG image file. The maximum upload file size for a JPG or PNG is 20mb.

• VIDEO: is a single MP4 video file. The maximum upload file size for a MP4 is 850mb.

PUThttps://api.orb360.tech/api/tenant/{tenantId}/shoot/{shootId}/media

Authorization

bearerapi_key

Path parameters

shootId*string

Unique shoot id

tenantId*string

Unique tenant id

Body

application/json

filenamestring

Filename of the media being uploaded - Allowed extensions are based on the meta.type value

tagsarray

Tag key-pairs to associate with the created media

metaobject

Response

200400401403404

success

Body

application/json

Other propertiesobject

The filename corresponding to the upload request

Request

JavaScriptCurl

const response = await fetch('https://api.orb360.tech/api/tenant/{tenantId}/shoot/{shootId}/media', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete Media

Delete media by id

Requires Admin role on the requested tenant

DELETEhttps://api.orb360.tech/api/tenant/{tenantId}/shoot/{shootId}/media/{mediaId}

Authorization

bearerapi_key

Path parameters

shootId*string

Unique shoot id

tenantId*string

Unique tenant id

mediaId*string

Unique media id

Response

200401403404

200 response

Body

application/json

messagestring

[200] media deletion successful

Request

JavaScriptCurl

const response = await fetch('https://api.orb360.tech/api/tenant/{tenantId}/shoot/{shootId}/media/{mediaId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "[200] media deletion successful"
}