3D Streaming Platform
How to Use the Conversion API
5 min
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 tab examples url https api senseofspace io conversionapi name create streamable asset method post request pathparameters queryparameters headerparameters bodydataparameters kind required name action type string description set this to create streamable asset kind required name asset name type string description asset name e g my model then the url of the asset would be https stream senseofspace io myuser my model kind required name p type string description password kind required name u type string description user name kind optional name photogrammetry type boolean description set this to true if the model is a photogrammetry or scanned model default false kind optional name model name type string description optional model name kind optional name model by type string description optional model provider name formdataparameters results languages id 1le1x3djyuqb4fn0doxnd code 48e99d92300cd0911602999668f54f23a5d32ef8 language 200 customlabel id liko9xsjkwtucuxjmmkhz code language 400 customlabel selectedlanguageid 1le1x3djyuqb4fn0doxnd examples languages id on7sgqlz3pbqfrmn4gqvw code curl request post n url https api senseofspace io conversionapi n header accept application json n data raw n u my user name n p my very secret pass n action create streamable asset n asset name my new model n photogrammetry false n language curl customlabel selectedlanguageid on7sgqlz3pbqfrmn4gqvw description creates a streamable asset entry for conversion returns the id of the created streamable asset currentnewparameter label body parameter value bodydataparameters 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 tab examples url https api senseofspace io conversionapi name get streamable asset upload url method post request pathparameters queryparameters headerparameters bodydataparameters kind required name action type string description set this to get streamable asset upload url kind required name asset id type string description id of a streamable asset which has not been converted yet kind required name p type string description password kind required name u type string description username formdataparameters results languages id asy9v84 vvku5cgevf9sf code https some url where to put the?file language 200 customlabel id z bcxzrp2mbchcdxnhtxb code language 400 customlabel selectedlanguageid asy9v84 vvku5cgevf9sf examples languages id bziy8qkorjm3 v9vfxly1 code curl request post n url https api senseofspace io conversionapi n header accept application json n data raw n u my user name n p my very secret pass n action get streamable asset upload url n assest id 48e99d92300cd0911602999668f54f23a5d32ef8 n language curl customlabel selectedlanguageid bziy8qkorjm3 v9vfxly1 description returns a url you can use to upload a glb model file with a put request valid for 15 minutes currentnewparameter label body parameter value bodydataparameters remove a streamable asset tab examples url https api senseofspace io conversionapi name remove streamable asset method post request pathparameters queryparameters headerparameters bodydataparameters kind required name action type string description set this to remove streamable asset kind required name asset id type string description id of the streamable asset to be removed kind required name p type string description password kind required name u type string description username formdataparameters results languages id tzgo0mlfdo5jddjz3j6m5 code language 200 customlabel id mpxqlambkxuyhidn1eqdo code language 400 customlabel selectedlanguageid tzgo0mlfdo5jddjz3j6m5 examples languages id 2gi7ry5k6e5wm9ywqwqxc code curl request post n url https api senseofspace io conversionapi n header accept application json n data raw n u my user name n p my very secret pass n action remove streamable asset n assest id 48e99d92300cd0911602999668f54f23a5d32ef8 n language curl customlabel selectedlanguageid 2gi7ry5k6e5wm9ywqwqxc description removes the hosted streamable asset files and marks the entry as hidden currentnewparameter label body parameter value bodydataparameters get streamable asset list tab examples url https api senseofspace io conversionapi name get streamable assets method post request pathparameters queryparameters headerparameters bodydataparameters kind required name action type string description set this to get streamable assets kind required name p type string description password kind required name u type string description username kind optional name get hidden type boolean description true or false to get hidden assets or not optional default false formdataparameters results languages id surqj45t jcngogjuhh9f code n n hidden false n assetid 48e99d92300cd0911602999668f54f23a5d32ef8 n assetname room n username my user n status ready n progress n lastmodified 1651835394619 n polygoncount 5294 n filesize 5470352 n billed false n n n hidden false n assetid aef9543ac1781e7543351d4c94fd756f4c391190 n assetname building n username my user n status ready n progress n lastmodified 1652167890336 n polygoncount 5294 n filesize 5470352 n billed false n n language 200 customlabel id vu274mgmbud2t7lxxc0wy code language 400 customlabel selectedlanguageid surqj45t jcngogjuhh9f examples languages id elbkxy16isvipjjyapoil code curl request post n url https api senseofspace io conversionapi n header accept application json n data raw n u my user name n p my very secret pass n action get streamable assets n language curl customlabel selectedlanguageid elbkxy16isvipjjyapoil description returns a list of all your streamable assets and their details as an array of objects in json string format currentnewparameter label body parameter value bodydataparameters