PUT /v1/models/:id

Description

Update model information. After successfully uploading file and images, set status to published

Headers

content_type

application/json

content_language

en-US

Parameters

status optional, type: String

Status of the model, available options: draft, published.

title optional, type: String

Title of the model

description optional, type: String

Model description

tags optional, type: Array

Model tags, minimum 5

category optional, type: String

Slug of models category.

subcategory optional, type: String

Slug of models subcategory.

price optional, type: Float

Download price.

license optional, type: String

Type of license, available options: general, editorial, custom.

custom_license optional, type: String

Custom license text. It is required if license is set to custom, only.User email

product_type optional, type: String

Represents type of model, available options: cg, printable. Default is cg.

game_ready optional, type: Boolean

Indicates whether the model is game ready. Note: only applicable to CG models.

animated optional, type: Boolean

Indicates whether the model is animated. Note: only applicable to CG models.

rigged optional, type: Boolean

Indicates whether the model is rigged. Note: only applicable to CG models.

pbr optional, type: Boolean

Indicates whether the model is pbr. Note: only applicable to CG models.

adult_content optional, type: Boolean

Indicates whether the model contains adult content.

ai_generated optional, type: Boolean

Indicates whether the model was created using AI tools.

units optional, type: String

Measurement units for the printable model (e.g. cm, mm, m, in). Note: only applicable to printable models. When updating, send product_type: "printable" alongside.

is_pre_supported optional, type: Boolean

Indicates whether the printable model is pre-supported for 3D printing. Note: only applicable to printable models. When updating, send product_type: "printable" alongside.

is_split_into_multiple_parts optional, type: Boolean

Indicates whether the printable model is split into multiple parts. Note: only applicable to printable models. When updating, send product_type: "printable" alongside.

multiple_parts_details optional, type: String

Description of the multiple parts the printable model is split into. Note: only applicable to printable models. When updating, send product_type: "printable" alongside.

info optional, type: Hash/Dictionary

Additional model information, such as number of polygons, vertices, whether the model has textures, etc. Possible geometry types: polygonal_mesh, gaussian_splats, subdivision_ready, nurbs, other. Values for unwrapped_uvs: unknown, non_overlapping, overlapping, mixed, no. Check the request example for more details. Note: only applicable to CG models.

Example Request

{
    "title": "Simple test model",
    "description": "This is a test model.",
    "tags": [
        "simple",
        "test",
        "model",
        "api",
        "example"
    ],
    "category": "car",
    "subcategoy": "sport",
    "price": 19.99,
    "license": "general",
    "game_ready": true,
    "pbr": true,
    "info": {
        "polygons": 1024,
        "vertices": 2048,
        "geometry_type": "nurbs",
        "collection": false,
        "textures": true,
        "materials": true,
        "plugins_used": false,
        "uvw_mapping": true,
        "unwrapped_uvs": "overlapping"
    }
}

Example Response

{
    "id": 12,
    "author_name": "cgtrader",
    "slug": "test-model",
    "title": "Test model",
    "downloadable": true,
    "description": "< p >Test model< / p >",
    "prices": {
        "download": "12.0"
    },
    "files": [
        {
            "id": 5,
            "name": "cube.stl",
            "size": 179289,
            "download_url": "https://api.cgtrader.com/v1/models/1/files/12"
        }
    ],
    "thumbnails": [
        "https://img-new.cgtrader.com/path_to_thumbnail_image.png"
    ]
}