PBRPX API Documentation

API Usage Terms

Developer Policy

We welcome developers to integrate the PBRPX API into your applications or tools, and also support academic researchers in batch obtaining resource data for research purposes.

Key Terms

✅ Free License: Completely open for non-profit projects and academic research

⚠️ Commercial License:

Commercial use requires customized licensing
Typically requires project sponsorship support
Note: Excludes projects directly contacted by PBRPX official

⚠️ Calling Specifications:

All API requests must include valid App-Agent header
App-Agent value should clearly identify your application name/identifier
Calls without proper headers will face access restrictions

❤️ Support Us:

Your support motivates us to continue providing quality API services
Welcome to support platform development through sponsorship or commercial cooperation
Let's maintain a healthy and sustainable open-source ecosystem together

Service Notes

1. This API service primarily serves PBRPX platform's own business needs

2. We reserve the right to periodically optimize and adjust API endpoints and authentication mechanisms

3. Integrators are advised to submit registration information via [email protected] to:

Receive important change notifications
Get priority technical support
Establish long-term cooperative relationships

We look forward to building a good developer ecosystem with you. If you have any special requirements or cooperation intentions, please feel free to contact us.

GET api.pbrpx.com/assets

Description

Retrieve a list of assets with pagination and category filtering support.

Parameters

Parameter	Type	Required	Default	Description
categorys	string[]	Optional	-	Category filter, multiple categorys parameters can be passed
page	integer	Optional	1	Page number
pageSize	integer	Optional	50	Items per page (max 50)

Example Requests

Get all assets (first page, 10 items)

https://api.pbrpx.com/assets?pageSize=10

Filter assets by category

https://api.pbrpx.com/assets?categorys=3D_Models&categorys=Nature&categorys=Tree

Success Response

{
  "data": [
    {
      "latinName": "Abies",
      "commonNameEN": [
        "Fir trunk"
      ],
      "productName": "PX_Abies_Trunk_15",
      "tagsEN": [
        "tree",
        "trunk",
        "bark",
        "conifer",
        "rough",
        "nature",
        "furrowed"
      ],
      "productCategories": {
        "3D_Models": {
          "Nature": {
            "Trees": {
              "Trunk": {}
            }
          }
        }
      },
      "physicalSize": "174 * 175 * 190cm",
      "path_key": "3D_Models/PX_Abies_Trunk_15",
      "thumbnail": "https://asset.pbrpx.com/3D_Models/PX_Abies_Trunk_15/PX_Abies_Trunk_15_preview_360_360.webp",
      "resolutions": [
        "1K",
        "2K",
        "4K",
        "8K"
      ]
    },
    // More assets...
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 10,
    "total": 710,
    "totalPages": 71
  }
}

GET api.pbrpx.com/info

Description

Retrieve detailed information about a specific asset.

Parameters

Parameter	Type	Required	Default	Description
productName	string	Required	-	Product name

Example Request

https://api.pbrpx.com/info?productName=PX_Rock_Slab_21

Success Response

{
  "latinName": "",
  "productName": "PX_Rock_Slab_21",
  "tagsEN": [
    "marble",
    "polished",
    "clean",
    "smooth",
    "decorative",
    "shiny",
    "porcelain",
    "interiors"
  ],
  "productCategories": {
    "Textures": {
      "Surfaces": {
        "Marble": {
          "Slabs": {}
        }
      }
    }
  },
  "physicalSize": "300 * 227cm",
  "file_list": [
    {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/config.json",
        "name": "config.json",
        "size": 835
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/PX_Rock_Slab_21.blend",
        "name": "PX_Rock_Slab_21.blend",
        "size": 185419
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/PX_Rock_Slab_21_preview.webp",
        "name": "PX_Rock_Slab_21_preview.webp",
        "size": 82144
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/PX_Rock_Slab_21_preview_360_360.png",
        "name": "PX_Rock_Slab_21_preview_360_360.png",
        "size": 390689
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/PX_Rock_Slab_21_preview_360_360.webp",
        "name": "PX_Rock_Slab_21_preview_360_360.webp",
        "size": 17656
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/16K/PX_Rock_Slab_21_albedo.jpg",
        "name": "PX_Rock_Slab_21_albedo.jpg",
        "size": 36219484
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/16K/PX_Rock_Slab_21_glossiness.jpg",
        "name": "PX_Rock_Slab_21_glossiness.jpg",
        "size": 7184946
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/16K/PX_Rock_Slab_21_roughness.jpg",
        "name": "PX_Rock_Slab_21_roughness.jpg",
        "size": 7177811
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/1K/PX_Rock_Slab_21_albedo.jpg",
        "name": "PX_Rock_Slab_21_albedo.jpg",
        "size": 180437
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/1K/PX_Rock_Slab_21_glossiness.jpg",
        "name": "PX_Rock_Slab_21_glossiness.jpg",
        "size": 33807
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/1K/PX_Rock_Slab_21_roughness.jpg",
        "name": "PX_Rock_Slab_21_roughness.jpg",
        "size": 33685
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/2K/PX_Rock_Slab_21_albedo.jpg",
        "name": "PX_Rock_Slab_21_albedo.jpg",
        "size": 683502
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/2K/PX_Rock_Slab_21_glossiness.jpg",
        "name": "PX_Rock_Slab_21_glossiness.jpg",
        "size": 126008
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/2K/PX_Rock_Slab_21_roughness.jpg",
        "name": "PX_Rock_Slab_21_roughness.jpg",
        "size": 125856
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/4K/PX_Rock_Slab_21_albedo.jpg",
        "name": "PX_Rock_Slab_21_albedo.jpg",
        "size": 2575031
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/4K/PX_Rock_Slab_21_glossiness.jpg",
        "name": "PX_Rock_Slab_21_glossiness.jpg",
        "size": 473936
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/4K/PX_Rock_Slab_21_roughness.jpg",
        "name": "PX_Rock_Slab_21_roughness.jpg",
        "size": 473299
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/8K/PX_Rock_Slab_21_albedo.jpg",
        "name": "PX_Rock_Slab_21_albedo.jpg",
        "size": 9721615
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/8K/PX_Rock_Slab_21_glossiness.jpg",
        "name": "PX_Rock_Slab_21_glossiness.jpg",
        "size": 1842802
      },
      {
        "downloadUrl": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/8K/PX_Rock_Slab_21_roughness.jpg",
        "name": "PX_Rock_Slab_21_roughness.jpg",
        "size": 1842212
      }
    // More files...
  ],
  "path_key": "Textures/PX_Rock_Slab_21",
  "thumbnail": "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/PX_Rock_Slab_21_preview_360_360.webp",
  "preview": [
    "https://asset.pbrpx.com/Textures/PX_Rock_Slab_21/PX_Rock_Slab_21_preview.webp"
  ],
  "resolutions": [
    "16K",
    "1K",
    "2K",
    "4K",
    "8K"
  ]
}

Error Response

400 Bad Request - Missing required parameter

{
  "errno": 400,
  "errmsg": "productName is required!"
}

GET api.pbrpx.com/categories

Description

Retrieve the complete category structure.

Parameters

None

Example Request

https://api.pbrpx.com/categories

Success Response

{
  "3D_Models": {
    "Nature": {
      "Trees": {
        "Trunk": {},
        "Burl": {},
        "Branch": {},
        "Fallen": {},
        "Log": {},
        "Stump": {}
      },
      "Rock": {
        "Beach": {}
      },
      "Dung": {},
      "Tree": {
        "Trunk": {},
        "Stump": {}
      },
      "Terrain": {}
    },
    "Food": {
      "Vegetable": {},
      "Fruit": {},
      "Mushroom": {}
    },
    "Street": {
      "Bollard": {},
      "Curb": {},
      "Equipment": {},
      "Gutter": {},
      "Sidewalk": {},
      "Speed_Bump": {},
      "Stairs": {},
      "Tree_Pit": {}
    },
    "Building": {
      "Debris": {},
      "Brick": {},
      "Wall": {}
    },
    "Interior": {
      "Chair": {},
      "Kitchenware": {}
    },
    "Props": {
      "Recreational": {},
      "Hardware": {}
    },
    "Rock": {
      "Mossy": {},
      "Embankment": {},
      "Quarry": {}
    },
    "Stone": {
      "Scatter": {}
    },
    "Storage": {
      "Barrel": {}
    }
  },
  "HDRI": {
    "Exterior": {
      "High_Contrast": {}
    }
  },
  "Photography": {
    "Landscape": {}
    },
  "Textures": {
    "Surfaces": {
      "Brick": {},
      "Concrete": {},
      "Tiles": {
        "Concrete": {}
      },
      "Gravel": {
        "Construction": {},
        "Natural": {}
      },
      "Debris": {},
      "Ground": {
        "Forest": {},
        "Road": {},
        "Grass": {},
        "Soil": {},
        "Root": {}
      },
      "Tile": {
        "Marble": {}
      },
      "Wood": {
        "Exterior": {},
        "Flooring": {}
      },
      "Sand": {},
      "Metal": {},
      "Soil": {},
      "Stone": {
        "Ground": {},
        "Cobblestone": {}
      },
      "Historical": {},
      "Asphalt": {},
      "Street": {
        "Sidewalks": {}
      },
      "Roof": {},
      "Bark": {},
      "Rock": {
        "Wall": {}
      },
      "Plastic": {},
      "Marble": {
        "Slabs": {}
      }
    },
    "Atlases": {
      "Debris": {
        "Trash": {}
      },
      "Shrub and Tree": {
        "Stem": {},
        "Leaf": {},
        "Flower": {},
        "Atlas": {}
      },
      "Flower and Grass": {
        "Medicinal Herb": {
          "Stem": {},
          "Flower": {},
          "Leaf": {},
          "Inflorescence": {},
          "Atlas": {},
          "Fruit": {}
        },
        "Ornamental": {
          "Leaf": {},
          "Stem": {},
          "Flower": {},
          "Atlas": {},
          "Fruit": {}
        },
        "Wild": {
          "Leaf": {},
          "Atlas": {},
          "Stem": {},
          "Inflorescence": {},
          "Flower": {}
        },
        "Flowers": {
          "Leaf": {},
          "Flower": {},
          "Atlas": {},
          "Stem": {}
        }
      },
      "Palm": {
        "Flower": {},
        "Atlas": {},
        "Leaf": {},
        "Stem": {}
      },
      "Succulents": {
        "Leaf": {},
        "Stem": {}
      },
      "Fruits and Vegetables": {
        "Stem": {},
        "Flower": {},
        "Leaf": {},
        "Atlas": {}
      },
      "Bamboo": {
        "Stem": {}
      },
      "Aquatic": {
        "Flower": {},
        "Leaf": {},
        "Atlas": {},
        "Fruit": {},
        "Stem": {}
      },
      "Creeping": {
        "Stem": {},
        "Flower": {},
        "Leaf": {},
        "Atlas": {}
      },
      "Fern": {
        "Leaf": {},
        "Atlas": {}
      }
    },
    "Decals": {
      "Door": {},
      "Moss": {},
      "Tree": {
        "Burl": {}
      },
      "Street": {
        "Manhole Cover": {},
        "Sidewalk": {},
        "Painted Line": {},
        "Sign": {}
      },
      "Debris": {}
    }
  }
}