{"openapi":"3.1.0","info":{"title":"Immerse API","version":"0.1.0","description":"A fully local, hand-curated VR (virtual reality) gaming reference: headset types (tethered, standalone, mobile-viewer, arcade/location-based) described generically, room-scale/seated/standing setup basics, a genre overview, practical non-medical comfort/motion-sickness tips, physical safety considerations, a term glossary, comfort-level genre suggestions, and beginner tips. Keyless; fully local; zero upstream calls.\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://immerse.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"hr@unifydynamics.com","url":"https://connectorbay.com/immerse/docs"},"termsOfService":"https://connectorbay.com/immerse/terms"},"servers":[{"url":"https://immerse.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/immerse/docs"},"security":[{},{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/headset_type_info":{"post":{"operationId":"headset_type_info","summary":"Full detail for one generic category of VR headset — tethered PC, console-tethered, standalone/all-in-one,","description":"Full detail for one generic category of VR headset — tethered PC, console-tethered, standalone/all-in-one,\n    phone-based mobile viewer, arcade/location-based, or passthrough/mixed-reality capability: how it works,\n    pros/cons, and what it's best for. Describes hardware categories functionally, not specific current commercial\n    models. Use for \"what is a standalone VR headset\", \"tethered vs all-in-one VR\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"description":"A VR headset category, name or alias.","examples":["standalone","tethered PC VR","mobile viewer","arcade VR"],"minLength":1,"title":"Type","type":"string"}},"required":["type"],"title":"headset_type_infoArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/setup_type_info":{"post":{"operationId":"setup_type_info","summary":"Explains one physical play setup — room-scale, seated, or standing — including how much real space it","description":"Explains one physical play setup — room-scale, seated, or standing — including how much real space it\n    needs, how it works, pros/cons, and what it's best for. With no type, lists all three. Use for \"how much space\n    do I need for room-scale VR\", \"what's the difference between seated and standing VR play\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"A play setup style; omit to list all three.","examples":["room-scale","seated","standing"],"title":"Type"}},"title":"setup_type_infoArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/genre_overview":{"post":{"operationId":"genre_overview","summary":"Explains a VR game genre — rhythm, shooter, puzzle, social, horror, sports & fitness, racing/vehicle sim,","description":"Explains a VR game genre — rhythm, shooter, puzzle, social, horror, sports & fitness, racing/vehicle sim,\n    narrative adventure, simulation/sandbox, or tabletop & board games: what it feels like, typical setup and\n    locomotion style, and a comfort rating (gentle/moderate/intense). With no genre, lists all of them. Use for\n    \"what VR genres exist\", \"what's a wave shooter\", \"is VR horror scary\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"genre":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"A VR game genre; omit to list all.","examples":["rhythm","shooter","puzzle","social","horror"],"title":"Genre"}},"title":"genre_overviewArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/find_genre_for_comfort_level":{"post":{"operationId":"find_genre_for_comfort_level","summary":"Suggests VR genres suited to a stated motion-sickness comfort level, from newcomer/sensitive up through","description":"Suggests VR genres suited to a stated motion-sickness comfort level, from newcomer/sensitive up through\n    experienced/strong-stomach. Comfort tolerance is cumulative: an experienced player's list includes every\n    gentler genre too. Use for \"I get motion sick easily, what VR games should I try\", \"what VR genre is best for\n    someone new to VR\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"comfort_level":{"description":"How sensitive you are to VR motion discomfort, in your own words.","examples":["I'm a total beginner and get motion sick easily","moderate, some experience","veteran, strong stomach"],"minLength":1,"title":"Comfort Level","type":"string"}},"required":["comfort_level"],"title":"find_genre_for_comfort_levelArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/comfort_tip":{"post":{"operationId":"comfort_tip","summary":"One practical, non-medical tip for reducing VR motion discomfort, keyed by topic — or, with no topic, the","description":"One practical, non-medical tip for reducing VR motion discomfort, keyed by topic — or, with no topic, the\n    full list of tip topics. General practical/wellness advice, not medical advice. Use for \"how do I stop feeling\n    sick in VR\", \"tips for VR motion sickness\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"A comfort/motion-sickness topic to look up; omit to list all.","examples":["teleport locomotion","session breaks","comfort vignette"],"title":"Topic"}},"title":"comfort_tipArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/safety_consideration":{"post":{"operationId":"safety_consideration","summary":"A physical-safety topic for VR play — clearing your space, cable/tripping hazards, boundary/guardian","description":"A physical-safety topic for VR play — clearing your space, cable/tripping hazards, boundary/guardian\n    systems, bystanders and pets, valuables, headset fit/hygiene, session breaks, or multiplayer awareness — with\n    guidance, why it matters, and a short checklist. With no topic, lists all of them. Use for \"what should I check\n    before playing VR at home\", \"is room-scale VR safe\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"A physical VR safety topic to look up; omit to list all.","examples":["boundary systems","tripping hazards","bystanders and pets"],"title":"Topic"}},"title":"safety_considerationArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/term_glossary":{"post":{"operationId":"term_glossary","summary":"Definitions of common VR vocabulary — FOV, IPD, 6DOF/3DOF, inside-out/outside-in tracking, passthrough,","description":"Definitions of common VR vocabulary — FOV, IPD, 6DOF/3DOF, inside-out/outside-in tracking, passthrough,\n    boundary/guardian, haptics, refresh rate, teleport vs. smooth locomotion, room-scale, presence, and more. Use\n    for \"what does IPD mean\", \"what's the difference between 3DOF and 6DOF\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"term":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"A specific VR term to look up; omit to list all.","title":"Term"}},"title":"term_glossaryArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/beginner_tips":{"post":{"operationId":"beginner_tips","summary":"A ranked shortlist of general tips for someone brand new to VR — clearing space, adjusting fit, starting","description":"A ranked shortlist of general tips for someone brand new to VR — clearing space, adjusting fit, starting\n    short, choosing locomotion, and more. Use for \"what should a VR beginner know\", \"tips for my first VR\n    session\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"count":{"default":5,"description":"How many tips to return.","maximum":10,"minimum":1,"title":"Count","type":"integer"}},"title":"beginner_tipsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}