Base Asset
These are sometimes referred to as raw models or source models in tutorials or elsewhere in the docs. Base asset is a user uploaded model. All future processing is applied to these assets only.
This is where you find endpoints some critical endpoints:
- Uploading a model
- Optimizing a model
- Read 3D Metadata of the uploaded model
- Get running jobs (we suggest you to check webhooks though)
- Find all optimized versions of a base asset
What happens to uploaded files?
Each base asset upload will trigger some analysis process to generate 3D metadata and render images for using that file in an easier way in downstream processes. You are going to find this data when you call Get Base Asset endpoint and look at .json or image files inside the data -> downloads.
Automatically exported models
If the uploaded model is a CAD file, we will also automatically output a .glb and .usd version of it. If the uploaded model is a 3ds Max file, we will automatically output a .glb, .gltf, .fbx, and .usdz version of it while translating all V-ray materials to PBR materials. Read reference documentation of DCC Importer for more information on this topic.
Base Asset Endpoints
Here are all the base asset endpoints:
📄️ Optimize
There are two ways to optimize a base asset. You can either send a config as a json object that complies with the [3D Processor Schema](https://docs.rapidpipeline.com/docs/componentDocs/3dProcessor/processor-schemas#the-3d-processing-schema), or send the id of one of the presets inside a preset_id key. Since the schema is complex, we suggest you to use the UI to create your preset and then use that preset_id in your Optimize call. You can also download the preset from the UI and use the contents of the downloaded config file in this API endpoint.
📄️ Multi Optimize
Optimizes multiple models with one request
📄️ Get Running Jobs
Returns rapidmodels (until 1 week) that are still being processed or were not successfully optimized
📄️ Get Base Asset
📄️ Delete Base Asset
📄️ Update Base Asset
Add Tags, Set scale factor. A tag can have 255 utf-8 characters including whitespaces.
📄️ Get Download URLs
Returns a list of urls to download the individual base asset files
📄️ Get imported DCC files
Returns a list of urls to download the individual converted DCC material and quality control files
📄️ Download zip
Downloads all model files as zip.
📄️ Delete Tag of a Base Asset
📄️ Get Base Assets
Paginated response of your base assets. Search for base assets by name or tag
📄️ Delete Multiple Base Assets
📄️ Create Base Asset - Get Upload Link
Calling this endpoint will return an id for the new base asset and presigned URLs which need to be used to upload the files directly to our storage. The URLs are unique for every file.
📄️ Create Base Asset - Complete Upload
Call this endpoint with the received base asset id from the 'Create Base Asset - Get Upload Link' endpoint after uploading the base asset files
📄️ Retries a failed import
📄️ Get Associated Rapid Models
Get all rapid models which were optimized from this base asset