Project Info
Get information about a project
GET https://cloud.unlimited3d.com/api/thirdParty/projects/{id}
Headers Parameters:
Name |
Type |
Required |
secret-key:: |
string |
yes |
public-key:: |
string |
yes |
Parameters:
Id of the project is a required parameter.
Name |
Type |
Required |
id: |
integer |
yes |
Example:
https://cloud.unlimited3d.com/api/thirdParty/projects/{id}
Create project
Create new project
POST https://cloud.unlimited3d.com/api/thirdParty/projects/create
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
metatags is json array with objects for each metatag. Example[{ “name”: “test”, “value”: “test”}, {“name”: “test1", “value”: “test1"}]
Name |
Type |
Required |
title: |
string |
yes |
description: |
string |
yes |
metatags: |
json |
no |
Update project
Update project details
POST https://cloud.unlimited3d.com/api/thirdParty/projects/update/{id}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
Name |
Type |
Required |
description: |
string |
no |
title: |
string |
no |
Parameters:
Name |
Type |
Required |
id: |
integer |
yes |
Project List
Get a list of available projects
GET https://cloud.unlimited3d.com/api/thirdParty/projects/
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Parameters:
Optional parameters are: limit, page and needle.
Needle is used as a search parameter, limit as a number of max results per page and page is available if the limit parameter is not equal to ‘all’.
Name |
Type |
Required |
needle: |
string |
no |
limit: |
integer |
no |
page: |
integer |
no |
Example:
https://cloud.unlimited3d.com/api/thirdParty/projects?limit=10&page=1
Get user subscription
Get subscription details for user
GET https://cloud.unlimited3d.com/api/thirdParty/user/subscription
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Solution List Per Project:
Get all available solutions per project
GET https://cloud.unlimited3d.com/api/thirdParty/projects/{id}/solutions
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Parameters:
Optional parameters are: limit, page and needle.
Needle is used as a search parameter, limit as a number of max results per page and page is available if the limit parameter is not equal to ‘all’.
Name |
Type |
Required |
id: |
integer |
no |
limit: |
integer |
no |
page: |
integer |
no |
needle: |
string |
no |
Example:
https://cloud.unlimited3d.com/api/thirdParty/projects/{id}/solutions?limit=10&page=1
Delete project
Delete project and asset and solutions in project
POST https://cloud.unlimited3d.com/api/thirdParty/projects/delete/{id}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
If stop_distributions is set to false, project will not be deleted if any of its solutions has live published distribution.
Name |
Type |
Required |
stop_distributions: |
bool |
no |
Parameters:
Name |
Type |
Required |
id: |
integer |
yes |
Get metatag for project
Get metatag details
GET https://cloud.unlimited3d.com/api/thirdParty/projects/{projectID}/metatags/{id}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Parameters:
Name |
Type |
Required |
projectID: |
integer |
yes |
id: |
integer |
yes |
Create metatag for project
Create new metatag for project
POST https://cloud.unlimited3d.com/api/thirdParty/projects/{projectID}/metatags/create
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
Name |
Type |
Required |
name: |
string |
no |
value: |
string |
no |
Parameters:
Name |
Type |
Required |
projectID: |
integer |
yes |
Update metatag for project
Update metatag details
POST https://cloud.unlimited3d.com/api/thirdParty/projects/{projectID}/metatags/update/{id}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
Name |
Type |
Required |
name: |
string |
no |
value: |
string |
no |
Parameters:
Name |
Type |
Required |
projectID: |
integer |
yes |
id: |
integer |
yes |
Get all metatags for projects
List all metatags for projects
GET https://cloud.unlimited3d.com/api/thirdParty/projects/{projectID}/metatags
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Parameters:
Optional parameters are: limit, page and needle. Needle is used as a search parameter, limit as a number of max results per page and page is available if the limit parameter is not equal to ‘all’.
Name |
Type |
Required |
projectID: |
integer |
yes |
needle: |
string |
no |
limit: |
integer |
no |
page: |
integer |
no |
Project List by Metatags
Get all available projects with a specific Metatag
POST https://cloud.unlimited3d.com/api/thirdParty/projects/metatag/{name}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Parameters:
Required parameter is the name of the Metatag.
Name |
Type |
Required |
name: |
string |
yes |
Delete metatag for project
Delete metatag
GET https://cloud.unlimited3d.com/api/thirdParty/projects/{projectID}/metatags/delete/{id}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
Name |
Type |
Required |
name: |
string |
no |
value: |
string |
no |
Parameters:
Name |
Type |
Required |
projectID: |
integer |
yes |
id: |
integer |
yes |
Solution info
Get information about a solution
GET https://cloud.unlimited3d.com/api/thirdParty/solutions/{id}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Parameters:
Id of the solution is a required parameter.
Name |
Type |
Required |
id: |
integer |
yes |
Create a solution
Create a solution inside of a specified project.
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/create
Headers Parameters:
.
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
Required body parameters are: title, description and project_id.
Title will be the name of the solution, Description is the description of the solution and project_id is the ID of the project where the solution will be created at.
metatags is json array with objects for each metatag. Example[{ “name”: “test”, “value”: “test”}, {“name”: “test1", “value”: “test1"}]
Name |
Type |
Required |
title: |
string |
no |
description: |
string |
no |
project_id: |
integer |
no |
metatags: |
json |
no |
Publish solution (deprecated)
Create new publish for solution
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/publish/{id}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Parameters:
Response:
jobID: id of the queued job
jobType: PublishSolution
Name |
Type |
Required |
id: |
integer |
yes |
Publish solution (async result)
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/{id}/publish
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Parameters:
Response:
jobID: id of the queued job
jobType: PublishSolution
Name |
Type |
Required |
id: |
integer |
yes |
Update solution
Update solution details
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/update/{id}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
Name |
Type |
Required |
title: |
string |
no |
description: |
string |
no |
Parameters:
Name |
Type |
Required |
id: |
integer |
yes |
Add model (deprecated)
Add a model to the specified solution.
Look below for new API for adding model.
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/{id}/addModel
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
Required parameters are modelName and modelGlb.
modelName will be the name of the model and modelGlb is the GLB model itself.
Name |
Type |
Required |
modelGlb: |
file |
yes |
modelName: |
string |
yes |
Parameters:
Required parameters are the ID of the solution,
ID of the solution is where the model be uploaded to.
Name |
Type |
Required |
id: |
integer |
yes |
Get signed AWS S3 url to upload file
.
POST https://cloud.unlimited3d.com/api/thirdParty/upload/getAWSS3url
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
Parameters:
filename: Name of the file under which you will upload it. eg.: “model.glb”. Please note
that the name of the file has to be unique.
Response:
url: aws S3 url to upload a file to
Name |
Type |
Required |
filename: |
string |
yes |
Upload model to the AWS S3 signed url
This API call is directly to the AWS S3 dedicated to your account under Threedium AWS S3.
You do not need any credentials because the url is already signed for you by Threedium.
More info:
https://docs.aws.amazon.com/AmazonS3/latest/userguide/PresignedUrlUploadObject.html
https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html
{Use AWS S3 Signed URL which you got from API: "Get signed AWS S3 url to upload file"}
Add model to solution (async result)
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/{id}/model/add
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
id: |
integer |
yes |
Body Parameters:
Parameters:
filename: Name of the file previously uploaded to S3 (glb)
deleteModel: If set to true, file will be deleted after processing is done. Default is false
Response:
jobID: id of the queued job
jobType: AddModelToSolution
Name |
Type |
Required |
filename: |
string |
yes |
deleteModel: |
bool |
no |
Solution List
Get all available solutions
GET https://cloud.unlimited3d.com/api/thirdParty/solutions/
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Parameters:
Optional parameters are: limit, page and needle.
Needle is used as a search parameter, limit as a number of max results per page and page is available if the limit parameter is not equal to ‘all’.
Name |
Type |
Required |
needle: |
string |
no |
limit: |
integer |
no |
page: |
integer |
no |
Example:
https://cloud.unlimited3d.com/api/thirdParty/solutions/?limit=10&page=1
Distribution Listing for a specific solution.
Get all available distributions for a specific solution.
GET https://cloud.unlimited3d.com/api/thirdParty/solutions/{id}/distributions
Headers Parameters:
Name |
Type |
Required |
secret-key: |
integer |
yes |
public-key: |
string |
yes |
Parameters:
Solution ID is a required parameter
Name |
Type |
Required |
id: |
integer |
yes |
Delete solution
Delete the specified solution
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/delete/{id}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
If stop_distributions is set to false, solution will not be deleted if it has live published distribution.
Name |
Type |
Required |
stop_distributions: |
bool |
no |
Parameters:
Required parameter is the ID of the solution.
Name |
Type |
Required |
id: |
integer |
yes |
Get metatag for solution
Get metatag details
GET https://cloud.unlimited3d.com/api/thirdParty/solutions/{solutionID}/metatags/{id}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Parameters:
Name |
Type |
Required |
solutionID: |
string |
yes |
id: |
integer |
yes |
Create metatag for solution
Create new metatag for solution
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/{solutionID}/metatags/create
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
Name |
Type |
Required |
name: |
string |
yes |
value: |
string |
yes |
Parameters:
Name |
Type |
Required |
solutionID: |
integer |
yes |
Update metatag for solution
Update metatag details
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/{solutionID}/metatags/update/{id}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
Name |
Type |
Required |
name: |
string |
no |
value: |
string |
no |
Parameters:
Name |
Type |
Required |
solutionID: |
integer |
yes |
id: |
integer |
yes |
Get all metatags for solution
List all metatags for solution
GET https://cloud.unlimited3d.com/api/thirdParty/solutions/{solutionID}/metatags
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Parameters:
Optional parameters are: limit, page and needle. Needle is used as a search parameter, limit as a number of max results per page and page is available if the limit parameter is not equal to ‘all’.
Name |
Type |
Required |
solutionID: |
integer |
yes |
needle: |
string |
no |
limit: |
integer |
no |
page: |
integer |
no |
Solution List by Metatags
Get all available solutions with a specific Metatag
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/metatag/{name}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Parameters:
Required parameter is the name of the Metatag
Name |
Type |
Required |
name: |
string |
yes |
Delete metatag for solution
Delete metatag
GET https://cloud.unlimited3d.com/api/thirdParty/solutions/{solutionID}/metatags/delete/{id}
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Body Parameters:
Name |
Type |
Required |
name: |
string |
no |
value: |
string |
no |
Parameters:
Name |
Type |
Required |
solutionID: |
integer |
yes |
id: |
integer |
yes |
Job status info
Return info status of the job.
POST https://cloud.unlimited3d.com/api/thirdParty/jobs/{id}/info
Headers Parameters:
Name |
Type |
Required |
secret-key: |
string |
yes |
public-key: |
string |
yes |
Parameters:
Response:
id: id of the job
Status: status of the job. It can be in progress or finished
type: type of the job
result: returned result of the job. Depends on job type.
errors: array of the errors if exists
warnings: array of the warnings if exists
Name |
Type |
Required |
id: |
integer |
yes |