Find a world by link or id
/api/world-lists/worlds/findTakes a world's link or id. A world Modbot has never read, or one VRChat refused before, is read from VRChat once (worlds.read). When VRChat cannot be asked right now, the world comes back by its id with no name, and Modbot names it later. When VRChat refuses it, nothing is stored and the refusal comes back in the 404.
Needs the ManageCalendar permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/api/world-lists/worlds/find" \ -H "Content-Type: application/json" \ -d '{ "text": "string" }'{ "worldId": "string", "name": null, "thumbnailUrl": null}Search known worlds GET
Worlds Modbot knows whose name holds the search, or whose id is it, most recently seen first, at most 50. Asks VRChat nothing. Needs the `ManageCalendar` permission.
Search VRChat's public worlds POST
Asks VRChat for up to 10 public worlds whose name holds the text (worlds.search, one search every 10 seconds). Each world found is kept as known, so a list can take it in. When searching again too soon, or when VRChat cannot be asked right now, nothing is sent and the reason comes back in the error. Needs the `ManageCalendar` permission.