Get a list of available projects.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
needle | string | no | Needle is used as a search parameter. |
limit | integer | yes | Number of max results per page. |
page | integer | yes | Page is available if the limit parameter is not equal to 'all'. |
Get information about a project.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the project. |
Create new project.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
title | string | yes | Title of the project. |
description | string | yes | Description of the project. |
metatags | json | no | Metatags is json array with objects for each metatag. Example[{ “name”: “test”, “value”: “test”}, {“name”: “test1", “value”: “test1"}] |
Update project details.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the project. |
Name | Type | Required | Description |
---|---|---|---|
title | string | no | Title of the project. |
description | string | no | Description of the project. |
Delete project, assets and solutions in project.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the project. |
Name | Type | Required | Description |
---|---|---|---|
stop_distribution | bool | no | If stop_distributions is set to false, project will not be deleted if any of its solutions has live published distribution. |
Get all available solutions per project.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the project. |
Name | Type | Required | Description |
---|---|---|---|
needle | string | no | Needle is used as a search parameter. |
limit | integer | no | Number of max results per page. |
page | integer | no | Page is available if the limit parameter is not equal to 'all'. |
Get all available solutions.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
needle | string | no | Needle is used as a search parameter. |
limit | integer | no | Number of max results per page. |
page | integer | no | Page is available if the limit parameter is not equal to 'all'. |
Get information about a solution.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the solution. |
Create a solution inside of a specified project.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
title | string | yes | Title of the solution. |
description | string | no | Description of the solution. |
project_id | integer | yes | ID of the project where the solution will be created at. |
metatags | json | no | Metatags is json array with objects for each metatag. Example[{ “name”: “test”, “value”: “test”}, {“name”: “test1", “value”: “test1"}]. |
Update solution details.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the solution. |
Name | Type | Required | Description |
---|---|---|---|
title | string | no | Title of the solution. |
description | string | no | Description of the solution. |
Delete the specified solution.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the solution. |
Name | Type | Required | Description |
---|---|---|---|
stop_distributions | bool | no | If stop_distributions is set to false, solution will not be deleted if it has live published distribution. |
Add model to solution.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the solution. |
Name | Type | Required | Description |
---|---|---|---|
filename | string | yes | Name of the file previously uploaded to S3 (glb). |
deleteModel | bool | no | If set to true, file will be deleted after processing is done. Default is false. |
Used to publish your solution.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the solution. |
Get all available distributions for a specific solution.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the solution. |
Create send request. Receiver must have SOLUTION_RECEIVER permission. New project will be created.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the solution. |
Name | Type | Required | Description |
---|---|---|---|
receiver_public_key | string | yes | Receiver's public key |
receiver_secret_key | string | yes | Receiver's secret key. |
project_title | string | yes | Title of the new project that will be created. |
project_description | string | yes | Description of the new project that will be created. |
Accept receive solution. Receiver keys in headers parameters, receiver must have SOLUTION_RECEIVER permission.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
sendReceiveID | integer | yes | Send/Receive ID |
Name | Type | Required | Description |
---|---|---|---|
token | string | yes | Token returned from send request api. |
Download assets from the solution.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the solution |
Get subscription details for user.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
user_id | integer | yes | ID of the user. |
Get all available projects with a specific Metatag.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
name | string | yes | Name of the metatag. |
Name | Type | Required | Description |
---|---|---|---|
name | string | yes | Name of the metatag. |
value | string | yes | Value of the metatag. |
List all metatags for project.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
projectID | integer | yes | ID of the project. |
needle | string | no | Needle is used as a search parameter. |
limit | integer | no | Number of max results per page. |
page | integer | no | Page is available if the limit parameter is not equal to 'all'. |
Get metatag details.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
projectID | integer | yes | ID of the project. |
id | integer | yes | ID of the metatag. |
Create new metatag for project.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
projectID | integer | yes | ID of the project. |
Name | Type | Required | Description |
---|---|---|---|
name | string | yes | Name of the Metatag. |
value | string | yes | Value of the Metatag. |
Update Metatag details for project.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
projectID | integer | yes | ID of the project. |
id | integer | yes | ID of the metatag. |
Name | Type | Required | Description |
---|---|---|---|
name | string | no | Name of the Metatag. |
value | string | no | Value of the metatag. |
Delete Metatag for project.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
projectID | integer | yes | ID of the project. |
id | integer | yes | ID of the metatag. |
Get all available solutions with a specific Metatag.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
name | string | yes | Name of the Metatag. |
Name | Type | Required | Description |
---|---|---|---|
name | string | yes | Name of the metatag. |
value | string | yes | Value of the metatag. |
List all Metatags for solution.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
solutionID | integer | yes | ID of the solution. |
needle | string | no | Needle is used as a search parameter. |
limit | integer | no | Number of max results per page. |
page | integer | no | Page is available if the limit parameter is not equal to 'all'. |
Get Metatag details for solution.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
solutionID | integer | yes | ID of the solution. |
id | integer | yes | ID of the metatag. |
Create new metatag for solution.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
solutionID | integer | yes | ID of the solution. |
Name | Type | Required | Description |
---|---|---|---|
name | string | yes | Name of the metatag. |
value | string | yes | Value of the metatag. |
Update metatag details for solution.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
solutionID | integer | yes | ID of the solution. |
id | integer | yes | ID of the metatag. |
Name | Type | Required | Description |
---|---|---|---|
name | string | yes | Name of the metatag. |
value | string | yes | Value of the metatag. |
Delete Metatag for solution.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
solutionID | integer | yes | ID of the solution. |
id | integer | yes | ID of the metatag. |
Get presigned AWS S3 URL.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
filename | string | yes | 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. |
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
Upload model to convert.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
filename | string | yes | Name of the file previously uploaded to S3 (fbx, obj). |
exportfilename | string | yes | Name of result file, after conversion. Must be .glb extension. |
Upload to optimize.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
filename | string | yes | The name of the previously uploaded file to S3 (glb). |
modelname | string | yes | The name that is being used during the process. |
tags | array | no | A list of tags. They will be returned along with the urls. |
exportfilename | string | yes | The basename of the optimized files. |
config | json | yes | The config of the optimizer as a json object. |
config.workflowSettings | json | yes | Specifies a target mesh resolution via a number of polygons. |
config.workflowSettings.targetMeshResolution | json | yes | Contains facePercentage and faceCount parameters. |
config.workflowSettings.targetMeshResolution.facePercentage | number ( facePercentage or faceCount ) | yes | Maximum polygonal resolution for mesh. |
config.workflowSettings.targetMeshResolution.faceCount | integer ( facePercentage or faceCount ) | yes | Maximum polygonal resolution for mesh. |
config.workflowSettings.targetTextureResolution | json | yes | Contains baseColor, emmisive, normal and orm parameters. |
config.workflowSettings.targetTextureResolution.baseColor | integer | yes | Value must be greater or equal to 1 and lesser or equal to 16384. |
config.workflowSettings.targetTextureResolution.emissive | integer | yes | Desired resolution for emissive map. Value must be greater or equal to 1 and lesser or equal to 16384. |
config.workflowSettings.targetTextureResolution.normal | integer | yes | Desired resolution for normal map. Value must be greater or equal to 1 and lesser or equal to 16384. |
config.workflowSettings.targetTextureResolution.orm | integer | yes | Desired resolution for ORM map. Value must be greater or equal to 1 and lesser or equal to 16384. |
config.sceneManipulation | json | no | Contains rotateZUp and centerModel parameters. |
config.sceneManipulation.rotateZUp | bool | no | Flag to specify if rotation to z-axis pointing upwards. |
config.sceneManipulation.centerModel | bool | no | Centers the model around the coordinate origin before export. |
config.assetSimplification | json | yes | Specifies how the asset should be simplified, including aspects such as node merging, tiling and atlasing, baking settings and more. |
config.assetSimplification.topologySettings | json | yes | Specifies detailed settings for mesh simplification. |
config.assetSimplification.topologySettings.vertexMergingDistance | number | yes | Threshold for merging closeby vertices, relative size to a normalized bounding box size. Value must be greater or equal to 0 and lesser or equal to 0.1. |
config.assetSimplification.topologySettings.meshDensityEqualization | number | yes | Amount of equalization for the triangle distribution (lower values lead to better shape preservation). Value must be greater or equal to 0 and lesser or equal to 1. |
config.assetSimplification.topologySettings.boundaryPreservationFactor | number | yes | Amount of enforced preservation of mesh boundaries (balancing boundary shapre vs. preservation of details elsewhere). Value must be greater or equal to 0 and lesser or equal to 1. |
config.compressionAndExport | json | yes | Settings for data compression and file export. |
config.compressionAndExport.fileExports | array | yes | List of desired file exports. |
config.compressionAndExport.fileExports.fileType | enum ( of string ). Must be one of: "glb", "usdz". | yes | File type of the exported file. |
config.compressionAndExport.fileExports.customScaling | number | yes | Alias for scaleFactor. |
config.compressionAndExport.fileExports.textureFormat | json | yes | Texture map format for export. |
config.compressionAndExport.fileExports.textureFormat.baseColor | enum | yes | Must be one of: "auto", "jpg", "png". |
config.compressionAndExport.fileExports.textureFormat.emissive | enum | yes | Must be one of: "auto", "jpg", "png". |
config.compressionAndExport.fileExports.textureFormat.normal | enum | yes | Must be one of: "auto", "jpg", "png". |
config.compressionAndExport.fileExports.textureFormat.orm | enum | yes | Must be one of: "auto", "jpg", "png". |
Returns info status of the job.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the job. |
Add model for optimization.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
filename | string | yes | Name of the file. |
title | string | no | Title of the model. |
delete_model | boolean | no | If set to true, file will be deleted after processing is done. Default is false. |
Send model for optimization.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the model. |
Name | Type | Required | Description |
---|---|---|---|
preset_id | integer | yes | ID of the preset. Only one of the body parameters is required - preset_id OR config. |
config | json | no | Custom configuration preset. Only one of the body parameters is required - preset_id OR config. |
Get all available optimizations.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
needle | string | no | Needle is used as a search parameter. |
limit | integer | no | Number of max results per page. |
page | integer | no | Page is available if the limit parameter is not equal to 'all'. |
Get information about optimization.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the optimization. |
Update optimization details.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the optimization. |
Name | Type | Required | Description |
---|---|---|---|
title | string | yes | Title of the optimization. |
description | string | no | Description of the optimization. |
Delete specific optimization.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the optimization. |
Get list of available presets.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
needle | string | no | Needle is used as a search parameter. |
limit | integer | no | Number of max results per page. |
page | integer | no | Page is available if the limit parameter is not equal to 'all'. |
Get available presets by their IDs.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
ids | array | yes | Array of the preset IDs. |
Get information about a preset.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the preset. |
Create new preset.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
title | string | yes | Title of the preset. |
description | string | no | Description of the preset. |
preset_data | json | yes | Preset configuration. |
Update preset details.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the preset. |
Name | Type | Required | Description |
---|---|---|---|
title | string | yes | Title of the preset. |
description | string | no | Description of the preset. |
preset_data | json | yes | Preset configuration. |
Delete optimization preset.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the preset. |
Get list of available global presets.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
needle | string | no | Needle is used as a search parameter. |
Get information about global preset.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
nameUnq | string | yes | Unique name of the preset. |
Get available models for optimization.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
needle | string | no | Needle is used as a search parameter. |
limit | integer | no | Number of max results per page. |
page | integer | no | Page is available if the limit parameter is not equal to 'all'. |
Get information about model for optimization.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the model for optimization. |
Update model for optimization details.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the model for optimization. |
Name | Type | Required | Description |
---|---|---|---|
title | string | yes | Title of the model for optimization. |
description | string | no | Description of the model for optimization. |
Delete model for optimization and all optimizations that belong to that model.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the model for optimization. |
Get available tags that belong to model for optimization.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the model for optimization. |
Create model for optimization tag.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
m_to_opt_id | integer | yes | ID of the model to optimize. |
tag | string | yes | Tag value. |
Update model for optimization tag details.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the tag. |
Name | Type | Required | Description |
---|---|---|---|
m_to_opt_id | integer | yes | ID of the model to optimize. |
tag | string | yes | Tag value. |
Delete tag that belongs to model for optimizaion.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the tag. |
Get available tags for optimization.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the optimization. |
Create tag for optimization.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
opt_id | integer | yes | ID of the optimization. |
tag | string | yes | Tag value. |
Update optimization tag details.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the optimization. |
Name | Type | Required | Description |
---|---|---|---|
opt_id | integer | yes | ID of the optimization |
tag | string | yes | Tag value. |
Delete tag that belongs to optimization.
Name | Type | Required |
---|---|---|
secret-key | string | yes |
public-key | string | yes |
Name | Type | Required | Description |
---|---|---|---|
id | integer | yes | ID of the tag. |