How to Use the Conversion API
7min
In this guide you'll find information in case you want to use our conversion to a streamable model system as an API.
You can use the API by sending HTTPS requests to https://api.senseofspace.io/ConversionApi
Parameters can be sent either in query string or as a JSON string in the request body.
Authentication
Every request requires your user id and password as parameters as follows:
u: “youruserid”
p: “yourpassword”
Create a streamable asset
Creates a streamable asset entry for conversion. Returns the id of the created streamable asset.
POST
Params
Body Parameters
action
required
String
Set this to "create_streamable_asset"
asset_name
required
String
Asset name. e.g. my_model. Then the URL of the asset would be https://stream.senseofspace.io/myuser/my_model
p
required
String
Password
u
required
String
User name
photogrammetry
optional
Boolean
Set this to true if the model is a photogrammetry or scanned model. Default false.
model_name
optional
String
Optional model name
model_by
optional
String
Optional model provider name
Get URL to upload the model file to be converted
After creating a streamable asset entry, you need to upload a model to start the conversion.
Only .GLB files are supported currently.
Returns a URL you can use to upload a .glb model file with a PUT request. Valid for 15 minutes.
POST
Params
Body Parameters
action
required
String
Set this to "get_streamable_asset_upload_url".
asset_id
required
String
ID of a streamable asset which has not been converted yet.
p
required
String
Password
u
required
String
Username
Remove a streamable asset
Removes the hosted streamable asset files and marks the entry as hidden.
POST
Params
Body Parameters
action
required
String
Set this to "remove_streamable_asset".
asset_id
required
String
ID of the streamable asset to be removed
p
required
String
Password
u
required
String
Username
Get streamable asset list
Returns a list of all your streamable assets and their details as an array of objects in JSON string format.
POST
Params
Body Parameters
action
required
String
Set this to "get_streamable_assets"
p
required
String
Password
u
required
String
Username
get_hidden
optional
Boolean
true or false to get hidden assets or not (optional, default false)
Updated 03 Mar 2023
Did this page help you?
Yes
No