Project
Solution
User
Metatags
Upload Model
Job
Optimization
Presets
Model for Optimization
Model for Optimization Tag
Optimization Tag
Go to Dark mode
Go to Light mode
Third Party Apps API Documentation - V1.0.0
Project
Get All
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:
| 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 By ID
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:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the project. |
Create
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 |
Parameters:
| 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
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 |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the project. |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| title | string | no | Title of the project. |
| description | string | no | Description of the project. |
Delete
Delete project, assets 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 |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the project. |
Body Parameters:
| 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 Solutions
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:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the project. |
Body Parameters:
| 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'. |
Solution
Get All
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:
| 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 By ID
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:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the solution. |
Create
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:
| 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
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 |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the solution. |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| title | string | no | Title of the solution. |
| description | string | no | Description of the solution. |
Delete
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 |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the solution. |
Body Parameters:
| 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 (async result)
Add model to solution.
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/{id}/model/add
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the solution. |
Body Parameters:
| 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. |
Publish Solution (async result)
Used to publish your solution.
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/{id}/publish
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the solution. |
Get All Distributions
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 | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the solution. |
Send Receive
Create send request. Receiver must have SOLUTION_RECEIVER permission. New project will be created.
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/{id}/requestCopy
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the solution. |
Body Parameters:
| 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
Accept receive solution. Receiver keys in headers parameters, receiver must have SOLUTION_RECEIVER permission.
POST https://cloud.unlimited3d.com/api/thirdParty/solutions/acceptCopy/{sendReceiveID}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| sendReceiveID | integer | yes | Send/Receive ID |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| token | string | yes | Token returned from send request api. |
Download assets
Download assets from the solution.
GET https://cloud.unlimited3d.com/api/thirdParty/solutions/{id}/assetsDownload
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the solution |
User
Get User Subscription
Get subscription details for user.
GET https://cloud.unlimited3d.com/api/thirdParty/{user_id}/subscription
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| user_id | integer | yes | ID of the user. |
Metatags
Get All Projects
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:
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Name of the metatag. |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Name of the metatag. |
| value | string | yes | Value of the metatag. |
Get All For Project
List all metatags for project.
GET https://cloud.unlimited3d.com/api/thirdParty/projects/{projectID}/metatags
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| 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 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 | Description |
|---|---|---|---|
| projectID | integer | yes | ID of the project. |
| id | integer | yes | ID of the metatag. |
Create 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 |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| projectID | integer | yes | ID of the project. |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Name of the Metatag. |
| value | string | yes | Value of the Metatag. |
Update For Project
Update Metatag details for project.
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 |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| projectID | integer | yes | ID of the project. |
| id | integer | yes | ID of the metatag. |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | no | Name of the Metatag. |
| value | string | no | Value of the metatag. |
Delete For Project
Delete Metatag for project.
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 |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| projectID | integer | yes | ID of the project. |
| id | integer | yes | ID of the metatag. |
Get All Solutions
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:
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Name of the Metatag. |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Name of the metatag. |
| value | string | yes | Value of the metatag. |
Get All 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:
| 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 For Solution
Get Metatag details for solution.
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 | Description |
|---|---|---|---|
| solutionID | integer | yes | ID of the solution. |
| id | integer | yes | ID of the metatag. |
Create 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 |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| solutionID | integer | yes | ID of the solution. |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Name of the metatag. |
| value | string | yes | Value of the metatag. |
Update for Solution
Update metatag details for solution.
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 |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| solutionID | integer | yes | ID of the solution. |
| id | integer | yes | ID of the metatag. |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Name of the metatag. |
| value | string | yes | Value of the metatag. |
Delete for Solution
Delete Metatag for solution.
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 |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| solutionID | integer | yes | ID of the solution. |
| id | integer | yes | ID of the metatag. |
Upload Model
Get Signed AWS S3 URL to Upload File
Get presigned AWS S3 URL.
POST https://cloud.unlimited3d.com/api/thirdParty/upload/getAWSS3url
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Body Parameters:
| 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. |
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"}
Upload Convert
Upload model to convert.
POST https://cloud.unlimited3d.com/api/thirdParty/upload/convert
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Body Parameters:
| 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 Optimize
Upload to optimize.
POST https://cloud.unlimited3d.com/api/thirdParty/upload-optimize
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Body Parameters:
| 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". |
Job
Job Status Info
Returns info status of the job.
GET https://cloud.unlimited3d.com/api/thirdParty/jobs/{id}/info
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the job. |
Optimization
Add Model to Optimize
Add model for optimization.
POST https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/models-to-optimize/create
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Body Parameters:
| 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. |
Optimize Model
Send model for optimization.
POST https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/models-to-optimize/optimize/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the model. |
Body Parameters:
| 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
Get all available optimizations.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/optimizations
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| 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 By ID
Get information about optimization.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/optimizations/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the optimization. |
Update
Update optimization details.
POST https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/optimizations/update/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the optimization. |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| title | string | yes | Title of the optimization. |
| description | string | no | Description of the optimization. |
Delete
Delete specific optimization.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/optimizations/delete/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the optimization. |
Presets
Get All
Get list of available presets.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/presets/
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| 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 By IDs
Get available presets by their IDs.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/presets/ids
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| ids | array | yes | Array of the preset IDs. |
Get By ID
Get information about a preset.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/presets/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the preset. |
Create
Create new preset.
POST https://cloud.unlimited3d.com/api/thirdParty/optimization/presets/create
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Body Parameters:
| 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
Update preset details.
POST https://cloud.unlimited3d.com/api/thirdParty/optimization/presets/update/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the preset. |
Body Parameters:
| 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
Delete optimization preset.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/presets/delete/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the preset. |
Get All Global
Get list of available global presets.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/global-presets
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| needle | string | no | Needle is used as a search parameter. |
Get Global By Unique Name
Get information about global preset.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/global-presets/{nameUnq}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| nameUnq | string | yes | Unique name of the preset. |
Model for Optimization
Get All
Get available models for optimization.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/models-to-optimize/
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| 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 By Id
Get information about model for optimization.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/models-to-optimize/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the model for optimization. |
Update
Update model for optimization details.
POST https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/models-to-optimize/update/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the model for optimization. |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| title | string | yes | Title of the model for optimization. |
| description | string | no | Description of the model for optimization. |
Delete
Delete model for optimization and all optimizations that belong to that model.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/models-to-optimize/delete/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the model for optimization. |
Model for Optimization Tag
Get All
Get available tags that belong to model for optimization.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/model-to-optimize-tags/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the model for optimization. |
Create
Create model for optimization tag.
POST https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/model-to-optimize-tags/create
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| m_to_opt_id | integer | yes | ID of the model to optimize. |
| tag | string | yes | Tag value. |
Update
Update model for optimization tag details.
POST https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/model-to-optimize-tags/update/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the tag. |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| m_to_opt_id | integer | yes | ID of the model to optimize. |
| tag | string | yes | Tag value. |
Delete
Delete tag that belongs to model for optimizaion.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/model-to-optimize-tags/delete/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the tag. |
Optimization Tag
Get All
Get available tags for optimization.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/optimization-tags/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the optimization. |
Create
Create tag for optimization.
POST https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/optimization-tags/create
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| opt_id | integer | yes | ID of the optimization. |
| tag | string | yes | Tag value. |
Update
Update optimization tag details.
POST https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/optimization-tags/update/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the optimization. |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| opt_id | integer | yes | ID of the optimization |
| tag | string | yes | Tag value. |
Delete
Delete tag that belongs to optimization.
GET https://cloud.unlimited3d.com/api/thirdParty/optimization/collections/optimization-tags/delete/{id}
Headers Parameters:
| Name | Type | Required |
|---|---|---|
| secret-key | string | yes |
| public-key | string | yes |
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ID of the tag. |
ON THIS PAGE
- Get All
- Get By ID
- Create
- Update
- Delete
- Get All Solutions
- Get All
- Get By ID
- Create
- Update
- Delete
- Add Model (async result)
- Publish Solution (async result)
- Get All Distributions
- Send Receive
- Accept Receive
- Download assets
- Get User Subscription
- Get All Projects
- Get All For Project
- Get For Project
- Create For Project
- Update For Project
- Delete For Project
- Get All Solutions
- Get All For Solution
- Get For Solution
- Create for Solution
- Update for Solution
- Delete for Solution
- Get Signed AWS S3 URL to Upload File
- Upload Model to the AWS S3 signed URL
- Upload Convert
- Upload Optimize
- Job Status Info
- Add Model to Optimize
- Optimize Model
- Get All
- Get By ID
- Update
- Delete
- Get All
- Get All By IDs
- Get By ID
- Create
- Update
- Delete
- Get All Global
- Get Global By Unique Name
- Get All
- Get By Id
- Update
- Delete
- Get All
- Create
- Update
- Delete
- Get All
- Create
- Update
- Delete