Vimmerse Freeport Platform APIs (1.1)

Download OpenAPI specification:Download

Vimmerse Freeport Platform APIs

Sessions

Create a new session.

Request
header Parameters
X-CLIENT-ID
string

client_id provided by vimmerse

X-API-KEY
string

API key provided by vimmerse

Responses
200

New session was created successfully and session information returned.

401

The client_id or api_key is not valid.

500

Error creating a new session

post/sessions
Request samples
Response samples
application/json
{
  • "id": "565a40bd-5873-411c-8597-b16820ed0403",
  • "created_at": "2022-03-19T15:51:50Z",
  • "updated_at": "2022-03-19T15:51:50Z",
  • "client_id": "test-client"
}

Get all of the sessions.

Request
header Parameters
X-CLIENT-ID
string

client_id provided by vimmerse

X-API-KEY
string

API key provided by vimmerse

Responses
200

Request successful and list of contents returned as an array.

401

The client_id or api_key is not valid.

500

Error getting a sessions list.

get/sessions
Request samples
Response samples
application/json
[
  • {
    }
]

Get a session detail.

Request
path Parameters
session_id
required
string

set id of the session to get detailed information.

header Parameters
X-CLIENT-ID
string

client_id provided by vimmerse

X-API-KEY
string

API key provided by vimmerse

Responses
200

Request successful and session information returned.

401

The client_id or api_key is not valid.

500

Error getting a session detail.

get/sessions/{session_id}
Request samples
Response samples
application/json
{
  • "updated_at": "2022-03-19T15:51:50Z",
  • "created_at": "2022-03-19T15:51:50Z",
  • "id": "565a40bd-5873-411c-8597-b16820ed0403",
  • "client_id": "test-client",
  • "files": [
    ]
}

Delete a session

Request
path Parameters
session_id
required
string

set id of the session to be removed.

header Parameters
X-CLIENT-ID
string

client_id provided by vimmerse

X-API-KEY
string

API key provided by vimmerse

Responses
200

Successful deletion of session.

401

The client_id or api_key is not valid.

500

Error deleting a session

delete/sessions/{session_id}
Request samples
Response samples
application/json
{ }

Get a url to upload a file.

Request
path Parameters
session_id
required
string

set id of the session to upload a file.

header Parameters
X-CLIENT-ID
string

client_id provided by vimmerse

X-API-KEY
string

API key provided by vimmerse

Request Body schema: application/json

set filename to upload.

filename
required
string

filename to upload.

Responses
200

A signed URL successfully provided.

401

The client_id or api_key is not valid.

500

Error generating signed URL.

post/sessions/{session_id}/file
Request samples
application/json
{
  • "filename": "v0.mp4"
}
Response samples
application/json
{
  • "signedUrl": "PRESIGNED URL"
}

Delete a file in a session.

Request
path Parameters
session_id
required
string

set id of the session to be removed.

key
required
string

Set file name to be removed.

header Parameters
X-CLIENT-ID
string

client_id provided by vimmerse

X-API-KEY
string

API key provided by vimmerse

Responses
200

Successful deletion of session file.

401

The client_id or api_key is not valid.

500

Error deleting a file

delete/sessions/{session_id}/file/{key}
Request samples
Response samples
application/json
{ }

Contents

Create a new content

Request
header Parameters
X-CLIENT-ID
string

client_id provided by vimmerse

X-API-KEY
string

API key provided by vimmerse

Request Body schema: application/json

creation parameters

session_id
required
string

ID of the session to be created.

is_public
required
boolean

A variable that lets your created content be public or nonpublic after content is created.

required
object
Responses
200

Content creation request was sent and is in progress.

401

The client_id or api_key is not valid.

500

Error creating a new content

post/contents
Request samples
application/json
{
  • "session_id": "565a40bd-5873-411c-8597-b16820ed0403",
  • "is_public": true,
  • "creation_params": {
    }
}
Response samples
application/json
{
  • "id": "42b50a0a-e800-472c-bdbd-d21f825f0613",
  • "client_id": "test-client",
  • "session_id": "565a40bd-5873-411c-8597-b16820ed0403",
  • "is_public": true,
  • "content_base_url": "42b50a0a-e800-472c-bdbd-d21f825f0613",
  • "available_3d_hls": true,
  • "available_bullet_hls": true,
  • "available_bullet_mp4": true,
  • "creation_version": "1",
  • "processing_status": "in progress",
  • "created_at": "2022-03-19T21:02:40Z",
  • "updated_at": "2022-03-19T21:02:40Z"
}

Get all of the contents.

Request
header Parameters
X-CLIENT-ID
string

client_id provided by vimmerse

X-API-KEY
string

API key provided by vimmerse

Responses
200

Request successful and list of contents returned as an array.

401

The client_id or api_key is not valid.

500

Error getting contents list

get/contents
Request samples
Response samples
application/json
[
  • {
    }
]

Get a content detail.

Request
path Parameters
content_id
required
string

set id of the content to get detailed information.

header Parameters
X-CLIENT-ID
string

client_id provided by vimmerse

X-API-KEY
string

API key provided by vimmerse

Responses
200

Request successful and content information returned.

401

The client_id or api_key is not valid.

500

Error getting a content detail

get/contents/{content_id}
Request samples
Response samples
application/json
{
  • "created_at": "2022-03-19T21:02:40Z",
  • "client_id": "test-client",
  • "processing_status": "success",
  • "creation_version": "1",
  • "available_bullet_mp4": true,
  • "available_bullet_hls": true,
  • "updated_at": "2022-03-19T21:26:45Z",
  • "available_3d_hls": true,
  • "is_public": true,
  • "session_id": "565a40bd-5873-411c-8597-b16820ed0403",
  • "id": "42b50a0a-e800-472c-bdbd-d21f825f0613"
}

Delete a content

Request
path Parameters
content_id
required
string

id of the content to be removed

header Parameters
X-CLIENT-ID
string

client_id provided by vimmerse

X-API-KEY
string

API key provided by vimmerse

Responses
200

Successful deletion of content.

401

The client_id or api_key is not valid.

500

Error deleting a content.

delete/contents/{content_id}
Request samples
Response samples
application/json
{ }