### GET /categories_json Source: https://docs.ambientcg.com/api/v2/categories_json This endpoint lists metadata about all asset categories. It supports searching, sorting, and filtering by category. ```APIDOC ## GET /categories_json ### Description This endpoint lists metadata about all asset categories. It supports searching, sorting, and filtering by category. ### Method GET ### Endpoint /categories_json ### Parameters #### Query Parameters - **q** (string) - Optional - Search Query. A list of keywords, separated by commas or spaces. - **sort** (string) - Optional - Defines the order of the results. Allowed values: `Alphabet`. - **Size** (string) - Optional - Not setting the parameter, setting it to an empty string or any other value will be interpreted as `Size`. - **category** (string) - Optional - Request data for one or multiple specific categories. Multiple values can be concatenated using a comma. Example: `Bricks,PavingStones`. ### Request Example ```json { "example": "GET /categories_json?q=stone&sort=Alphabet&category=Bricks,PavingStones" } ``` ### Response #### Success Response (200) - **categories** (array) - An array of category objects, each containing metadata. - **id** (integer) - The unique identifier for the category. - **name** (string) - The name of the category. - **slug** (string) - A URL-friendly version of the category name. - **asset_count** (integer) - The number of assets in the category. #### Response Example ```json { "example": { "categories": [ { "id": 1, "name": "Bricks", "slug": "bricks", "asset_count": 150 }, { "id": 2, "name": "Paving Stones", "slug": "paving-stones", "asset_count": 120 } ] } } ``` ``` -------------------------------- ### GET /releases_rss Source: https://docs.ambientcg.com/api/v2/releases_rss Retrieves an RSS feed containing new asset releases from AmbientCG. This endpoint does not require any parameters. ```APIDOC ## GET /releases_rss ### Description This endpoint provides an RSS-feed with new asset releases. ### Method GET ### Endpoint /websites/ambientcg_api_v2/releases_rss ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **feed** (XML) - The RSS feed content detailing new asset releases. #### Response Example ```xml AmbientCG New Releases https://ambientcg.com/ Latest asset releases from AmbientCG New Asset 1 https://ambientcg.com/asset/newasset1 Description of New Asset 1 Wed, 14 Feb 2024 10:00:00 GMT New Asset 2 https://ambientcg.com/asset/newasset2 Description of New Asset 2 Tue, 13 Feb 2024 15:30:00 GMT ``` ``` -------------------------------- ### GET /api/v2/full_json Source: https://docs.ambientcg.com/api/v2/full_json Fetches all available asset data in JSON format. This endpoint allows for detailed filtering and sorting based on various criteria such as asset type, creation method, popularity, and release date. ```APIDOC ## GET /api/v2/full_json ### Description This endpoint provides comprehensive metadata and downloadable file information for all assets available on AmbientCG. It supports a wide range of query parameters to filter, sort, and customize the returned data, making it suitable for advanced integration and data retrieval. ### Method GET ### Endpoint /api/v2/full_json ### Parameters #### Query Parameters - **q** (string) - Optional - Search query. Keywords can be separated by commas or spaces. - **type** (string) - Optional - The data type of the assets. Allowed values: `3DModel`, `Atlas`, `Brush`, `Decal`, `HDRI`, `Material`, `PlainTexture`, `Substance`, `Terrain`. Multiple values can be concatenated with a comma (logical OR). - **method** (string) - Optional - Method used to create the asset. Allowed values: `PBRApproximated`, `PBRPhotogrammetry`, `PBRProcedural`, `PBRMultiAngle`, `3DPhotogrammetry`, `HDRIStitched`, `HDRIStitchedEdited`, `PlainPhoto`, `UnknownOrOther`. Multiple values can be concatenated with a comma (logical OR). - **sort** (string) - Optional - Defines the order of the results. Allowed values: `Latest`, `Popular`, `Alphabet`, `Downloads`. Defaults to `Latest`. - **id** (string) - Optional - Can be used to select specific assets by their ID. Multiple IDs can be concatenated with a comma. - **date** (string) - Optional - Returns all assets released on a specific day. Format: `YYYY-MM-DD`. - **limit** (integer) - Optional - Defines the maximum number of results to be shown. Between 1 and 250. - **offset** (integer) - Optional - Defines the offset in the results. Skips a specified number of assets. Only effective if `limit` is set. - **include** (string) - Optional - Controls what data should be returned. Multiple values can be concatenated with a comma. Allowed values: `statisticsData`, `tagData`, `displayData`, `dimensionsData`, `relationshipData`, `neighbourData`, `downloadData`, `previewData`, `mapData`, `usdData`, `imageData`. ### Request Example ``` GET https://ambientcg.com/api/v2/full_json?type=Material&method=PBRPhotogrammetry&sort=Popular&limit=10&include=tagData,downloadData ``` ### Response #### Success Response (200) - **assets** (array) - An array of asset objects, each containing detailed metadata. - **id** (string) - Unique identifier for the asset. - **name** (string) - Name of the asset. - **type** (string) - Type of the asset (e.g., Material, 3DModel). - **method** (string) - Creation method of the asset. - **tags** (array) - Array of tags associated with the asset. - **downloads** (object) - Information about asset downloads (if `include=downloadData` is set). - ... (other metadata fields based on `include` parameter) #### Response Example ```json { "assets": [ { "id": "PavingStones036", "name": "Paving Stones 036", "type": "Material", "method": "PBRPhotogrammetry", "tags": ["stone", "paving", "outdoor"], "downloads": { "png": { "url": "https://cdn.ambientcg.com/downloads/PavingStones036/PavingStones036_PNG.zip", "size": 12345678 }, "exr": { "url": "https://cdn.ambientcg.com/downloads/PavingStones036/PavingStones036_EXR.zip", "size": 23456789 } }, "displayData": { "preview": "https://cdn.ambientcg.com/previews/PavingStones036.jpg" } } // ... more assets ] } ``` ``` -------------------------------- ### GET /api/v2/downloads_csv Source: https://docs.ambientcg.com/api/v2/downloads_csv Retrieves a list of downloadable assets in CSV format. This endpoint supports various query parameters to filter and sort the results, mirroring the search functionality on the AmbientCG website. ```APIDOC ## GET /api/v2/downloads_csv ### Description This endpoint lists downloadable files in an easy-to-parse CSV format. It allows for filtering by search query, asset type, creation method, sorting preferences, specific asset IDs, and release date. ### Method GET ### Endpoint /api/v2/downloads_csv ### Parameters #### Query Parameters - **q** (string) - Optional - Search query. A list of keywords, separated by commas or spaces. - **type** (string) - Optional - The data type of the assets. Allowed values: `3DModel`, `Atlas`, `Brush`, `Decal`, `HDRI`, `Material`, `PlainTexture`, `Substance`, `Terrain`. Multiple values can be concatenated with a comma (logical OR). An empty string or unset parameter disables the filter. - **method** (string) - Optional - Method used to create the asset. Allowed values: `PBRApproximated`, `PBRPhotogrammetry`, `PBRProcedural`, `PBRMultiAngle`, `3DPhotogrammetry`, `HDRIStitched`, `HDRIStitchedEdited`, `PlainPhoto`, `UnknownOrOther`. Multiple values can be concatenated with a comma (logical OR). An empty string or unset parameter disables the filter. - **sort** (string) - Optional - Defines the order of the results. Allowed values: `Latest`, `Popular`, `Alphabet`, `Downloads`. Defaults to `Latest` if unset, empty, or invalid. - **id** (string) - Optional - Can be used to select specific assets by their ID. Multiple values can be concatenated with a comma. Non-existent IDs will be ignored. - **date** (string) - Optional - Returns all assets released on a specific day. Format: `YYYY-MM-DD`. Invalid values will lead to zero results. ### Request Example ``` https://ambientcg.com/api/v2/downloads_csv?method=PBRPhotogrammetry&type=Material&sort=Popular&q=wood,texture ``` ### Response #### Success Response (200) - **CSV Data** (string) - A string containing the asset data in CSV format. ``` -------------------------------- ### Full JSON API Source: https://docs.ambientcg.com/api/v2/index Delivers comprehensive metadata and downloadable file information for all assets in an elaborate JSON format. ```APIDOC ## GET /full_json ### Description Delivers metadata and downloadable files for all assets in a more elaborate JSON-format. ### Method GET ### Endpoint https://ambientCG.com/api/v2/full_json ### Parameters #### Query Parameters None ### Request Example ``` GET https://ambientCG.com/api/v2/full_json ``` ### Response #### Success Response (200) - **assets** (array) - An array of asset objects, each containing detailed metadata and download links. #### Response Example ```json { "assets": [ { "id": "1", "name": "Oak Wood", "description": "A realistic oak wood texture.", "category": "Wood", "tags": ["wood", "texture", "natural"], "downloadLink": "https://ambientCG.com/download/1/Oak_Wood", "rawLink": "https://cdn.ambientcg.com/assets/1/Oak_Wood.zip", "fileSize": "10MB", "resolution": "4K" }, { "id": "2", "name": "Brushed Metal", "description": "A metallic surface with fine brush strokes.", "category": "Metal", "tags": ["metal", "brushed", "texture"], "downloadLink": "https://ambientCG.com/download/2/Brushed_Metal", "rawLink": "https://cdn.ambientcg.com/assets/2/Brushed_Metal.zip", "fileSize": "5MB", "resolution": "2K" } ] } ``` ``` -------------------------------- ### Categories Metadata API Source: https://docs.ambientcg.com/api/v2/index Retrieves metadata about asset categories available on AmbientCG. ```APIDOC ## GET /categories-json ### Description Lists metadata about asset categories. ### Method GET ### Endpoint https://ambientCG.com/api/v2/categories-json ### Parameters #### Query Parameters None ### Request Example ``` GET https://ambientCG.com/api/v2/categories-json ``` ### Response #### Success Response (200) - **categories** (array) - An array of category objects, each containing metadata. #### Response Example ```json { "categories": [ { "id": "1", "name": "Wood", "assetCount": 150 }, { "id": "2", "name": "Metal", "assetCount": 120 } ] } ``` ``` -------------------------------- ### Downloads CSV API Source: https://docs.ambientcg.com/api/v2/index Provides a list of downloadable files in CSV format. ```APIDOC ## GET /downloads_csv ### Description Lists downloadable files in an easy to parse CSV-format. ### Method GET ### Endpoint https://ambientCG.com/api/v2/downloads_csv ### Parameters #### Query Parameters None ### Request Example ``` GET https://ambientCG.com/api/v2/downloads_csv ``` ### Response #### Success Response (200) - **CSV Data** (string) - A string containing the data in CSV format. #### Response Example ```csv assetId,assetName,downloadLink,rawLink,category 1,Oak Wood,https://ambientCG.com/download/1/Oak_Wood,https://cdn.ambientcg.com/assets/1/Oak_Wood.zip,Wood 2,Brushed Metal,https://ambientCG.com/download/2/Brushed_Metal,https://cdn.ambientcg.com/assets/2/Brushed_Metal.zip,Metal ``` ``` -------------------------------- ### Releases RSS Feed API Source: https://docs.ambientcg.com/api/v2/index Provides an RSS feed of new asset releases. ```APIDOC ## GET /releases_rss ### Description Provides an RSS-feed with new asset releases. ### Method GET ### Endpoint https://ambientCG.com/api/v2/releases_rss ### Parameters #### Query Parameters None ### Request Example ``` GET https://ambientCG.com/api/v2/releases_rss ``` ### Response #### Success Response (200) - **RSS Feed** (xml) - An XML document containing the RSS feed of new releases. #### Response Example ```xml AmbientCG New Releases https://ambientCG.com/ Latest asset releases from AmbientCG. New Wood Texture Added https://ambientCG.com/asset/1 A high-quality Oak Wood texture has been released. Tue, 15 Aug 2023 10:00:00 GMT Brushed Metal Released https://ambientCG.com/asset/2 Check out the new Brushed Metal asset. Mon, 14 Aug 2023 15:30:00 GMT ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.