Toolbox (v1)

OpenCloud v1 reference for Toolbox.

Base URL: https://apis.roblox.com

Endpoints

Method	Path	Name
GET	/toolbox-service/v2/assets:search	getToolboxServiceV2AssetsSearch
GET	/toolbox-service/v2/assets/:id	getToolboxServiceV2AssetsId

getToolboxServiceV2AssetsSearch

GET /toolbox-service/v2/assets:search

BETA Search Creator Store for assets. Engine: Usable with HttpService

Scopes: creator-store-product:read

Usage

import { fetchApi } from 'rozod';
import { getToolboxServiceV2AssetsSearch } from 'rozod/lib/opencloud/v1/toolbox';

const data = await fetchApi(getToolboxServiceV2AssetsSearch, {
  query: /* string? */,
  modelSubTypes: /* array \| null? */,
  excludedModelSubTypes: /* array \| null? */,
  userId: /* integer \| null? */,
  groupId: /* integer \| null? */,
  pageToken: /* string? */,
  pageNumber: /* integer \| null? */,
  maxPageSize: /* integer? = 25 */,
  audioMinDurationSeconds: /* integer? */,
  audioMaxDurationSeconds: /* integer \| null? */,
  audioArtist: /* string? */,
  audioAlbum: /* string? */,
  includeTopCharts: /* boolean \| null? */,
  audioTypes: /* array \| null? */,
  includedInstanceTypes: /* array \| null? */,
  includeOnlyVerifiedCreators: /* boolean? = true */,
  minPriceCents: /* integer? */,
  maxPriceCents: /* integer \| null? */,
  facets: /* string \| null? */,
  categoryPath: /* string? */
});

Parameters

Name	Type	Required	Description
query	string?	No	The search terms used to filter the results.
modelSubTypes	array | null?	No	When searching for models, the subtypes associated with the search results.
excludedModelSubTypes	array | null?	No	When searching for models, the subtypes not associated with the search results.
userId	integer | null?	No	The User ID of the creator. Only one of ‘userId’ and ‘groupId’ can be present in a query.
groupId	integer | null?	No	The Group ID of the creator. Only one of ‘userId’ and ‘groupId’ can be present in a query.
pageToken	string?	No	The identifier for the desired search results page. Only one of ‘pageNumber’ and ‘pageToken’ can be present in a query.
pageNumber	integer | null?	No	The page number to retrieve, starting from 0. Only one of ‘pageNumber’ and ‘pageToken’ can be present in a query.
maxPageSize	integer? = 25	No	The number of assets to be returned. Cannot be larger than 100.
audioMinDurationSeconds	integer?	No	When searching for audio, the minimum duration of the audio assets. If included, must be greater than or equal to 0.
audioMaxDurationSeconds	integer | null?	No	When searching for audio, the maximum duration of the audio assets. If included, must be greater than or equal to 0.
audioArtist	string?	No	When searching for audio, the artist name of the audio assets.
audioAlbum	string?	No	When searching for audio, the album name of the audio assets.
includeTopCharts	boolean | null?	No
audioTypes	array | null?	No	When searching for audio, the type of the audio assets.
includedInstanceTypes	array | null?	No	When searching for models, this filters that the following Instance types are included in the model.
includeOnlyVerifiedCreators	boolean? = true	No	Whether the results should only include assets created by verified creators.
minPriceCents	integer?	No	The minimum price of the asset in cents. If included, must be greater than or equal to 0.
maxPriceCents	integer | null?	No	The maximum price of the asset in cents. If included, must be greater than or equal to 0.
facets	string | null?	No	Additional keywords to query by.
categoryPath	string?	No

Response

Type: SearchCreatorStoreAssetsResponse.nullable()

Errors

Status	Description
400	Bad Request
429	Too Many Requests
500	Server Error

---

getToolboxServiceV2AssetsId

GET /toolbox-service/v2/assets/:id

BETA Get details for a single Creator Store asset. Engine: Usable with HttpService

Scopes: creator-store-product:read

Usage

import { fetchApi } from 'rozod';
import { getToolboxServiceV2AssetsId } from 'rozod/lib/opencloud/v1/toolbox';

const data = await fetchApi(getToolboxServiceV2AssetsId, {
  id: /* integer */
});

Parameters

Name	Type	Required	Description
id	integer	Yes	The asset ID to retrieve details for.

Response

Type: CreatorStoreAsset.nullable()

Errors

Status	Description
403	Forbidden
404	Not Found
429	Too Many Requests

---