Open Brush MCP Server

Overview Schema Related Servers Score Discussions

openbrush-mcp

commands.html•44.5 kB

<!doctype html><html lang='en'> <head><meta charset='UTF-8'></head> <body><h3>Open Brush API Commands</h3>To run commands a request to this url with http://localhost:40074/api/v1? Commands are querystring parameters: commandname=parameters Separate multiple commands with & Example: <a href='http://localhost:40074/api/v1?brush.turn.y=45&brush.draw=1'>http://localhost:40074/api/v1?brush.turn.y=45&brush.draw=1</a> <dl> <dt>draw.paths (string jsonString) <a href="/api/v1?draw.paths=[[0,0,0],[1,0,0],[1,1,0]],[[0,0,-1],[-1,0,-1],[-1,1,-1]]" target="_blank">Try it</a></dt> <dd>Draws a series of paths at the current brush position [[[x1,y1,z1],[x2,y2,z2], etc...]]. Does not move the brush position </dd> <dt>brush.pathsmoothing (float amount) <a href="/api/v1?brush.pathsmoothing=0.1" target="_blank">Try it</a></dt> <dd>Sets the amount of smoothing applied to brush paths at corners. Default is 0.10 turns off smoothing and you'll have to ensure you create enough points or else the path may end up smoothed to nothing. </dd> <dt>draw.path (string jsonString) <a href="/api/v1?draw.path=[0,0,0],[1,0,0],[1,1,0],[0,1,0]" target="_blank">Try it</a></dt> <dd>Draws a path at the current brush position [x1,y1,z1],[x2,y2,z2], etc.... Does not move the brush position </dd> <dt>draw.stroke (string jsonString) <a href="/api/v1?draw.stroke=[0,0,0,0,180,90,.75],[1,0,0,0,180,90,.75],[1,1,0,0,180,90,.75],[0,1,0,0,180,90,.75]" target="_blank">Try it</a></dt> <dd>Draws an exact brush stroke including orientation and pressure </dd> <dt>draw.polygon (int sides, float radius, float angle) <a href="/api/v1?draw.polygon=5,2.5,45" target="_blank">Try it</a></dt> <dd>Draws a polygon at the current brush position. Does not move the brush position </dd> <dt>draw.text (string text) <a href="/api/v1?draw.text=hello world" target="_blank">Try it</a></dt> <dd>Draws the characters supplied at the current brush position </dd> <dt>draw.opentypetext (string text, string fontPath) <a href="/api/v1?draw.opentypetext=hello world,hello world,calibri.ttf" target="_blank">Try it</a></dt> <dd>Same as draw text but uses an opentype font (the font should be in a Fonts folder in your Open Brush folder) </dd> <dt>draw.svg (string svg) <a href="/api/v1?draw.svg" target="_blank">Try it</a></dt> <dd>Draws an entire SVG document </dd> <dt>draw.svg.path (string svgPath) <a href="/api/v1?draw.svg.path=M 184,199 116,170 53,209.6 60,136.2 4.3,88" target="_blank">Try it</a></dt> <dd>Draws the path supplied as an SVG Path string at the current brush position </dd> <dt>brush.type (string brushType) <a href="/api/v1?brush.type=ink" target="_blank">Try it</a></dt> <dd>Changes the brush. brushType can either be the brush name or it's guid. brushes are listed in the /help screen </dd> <dt>color.add.hsv (Vector3 hsv) <a href="/api/v1?color.add.hsv=0.1,0.2,0.3" target="_blank">Try it</a></dt> <dd>Adds the supplied values to the current color. Values are hue, saturation and value </dd> <dt>color.add.rgb (Vector3 rgb) <a href="/api/v1?color.add.rgb=0.1,0.2,0.3" target="_blank">Try it</a></dt> <dd>Adds the supplied values to the current color. Values are red green and blue </dd> <dt>color.set.rgb (Vector3 rgb) <a href="/api/v1?color.set.rgb=0.1,0.2,0.3" target="_blank">Try it</a></dt> <dd>Sets the current color. Values are red, green and blue </dd> <dt>color.set.hsv (Vector3 hsv) <a href="/api/v1?color.set.hsv=0.1,0.2,0.3" target="_blank">Try it</a></dt> <dd>Sets the current color. Values are hue, saturation and value </dd> <dt>color.set.html (string color) <a href="/api/v1?color.set.html=darkblue" target="_blank">Try it</a></dt> <dd>Sets the current color. colorString can either be a hex value or a css color name. </dd> <dt>brush.size.set (float size) <a href="/api/v1?brush.size.set=0.5" target="_blank">Try it</a></dt> <dd>Sets the current brush size </dd> <dt>brush.size.add (float amount) <a href="/api/v1?brush.size.add=0.1" target="_blank">Try it</a></dt> <dd>Changes the current brush size by the given amount </dd> <dt>draw.camerapath (int index, float step) <a href="/api/v1?draw.camerapath=0" target="_blank">Try it</a></dt> <dd>Draws along a camera path with the current brush settings </dd> <dt>model.webimport (string url) <a href="/api/v1?model.webimport=Andy\Andy.obj" target="_blank">Try it</a></dt> <dd>Imports a model given a url or a filename in Media Library\Models (Models loaded from a url are saved locally first) </dd> <dt>import.webmodel (string url) <a href="/api/v1?import.webmodel=Andy\Andy.obj" target="_blank">Try it</a></dt> <dd>Same as model.webimport (backwards compatibility for poly.pizza) </dd> <dt>model.icosaimport (string modelId) <a href="/api/v1?model.icosaimport=9L2Lt-sxzdp" target="_blank">Try it</a></dt> <dd>Imports a model from the Icosa Gallery given a model id </dd> <dt>model.import (string location) <a href="/api/v1?model.import=Andy.glb" target="_blank">Try it</a></dt> <dd>Imports a model given a filename in Media Library\Models (Models loaded from a url are saved locally first) </dd> <dt>model.breakapart (int index) <a href="/api/v1?model.breakapart=0" target="_blank">Try it</a></dt> <dd>Breaks apart a model </dd> <dt>save.overwrite <a href="/api/v1?save.overwrite" target="_blank">Try it</a></dt> <dd>Save the current scene overwriting the last save if it exists </dd> <dt>save.as (string filename) <a href="/api/v1?save.as=newSketch" target="_blank">Try it</a></dt> <dd>Saves the current scene under a new name. (No need to include the .tilt suffix) </dd> <dt>save.new <a href="/api/v1?save.new" target="_blank">Try it</a></dt> <dd>Saves the current scene in a new slot </dd> <dt>save.selected <a href="/api/v1?save.selected" target="_blank">Try it</a></dt> <dd>Saves the current selected strokes in a new slot </dd> <dt>icosa.upload <a href="/api/v1?icosa.upload" target="_blank">Try it</a></dt> <dd>Uploads it to the Icosa Gallery </dd> <dt>export.all <a href="/api/v1?export.all" target="_blank">Try it</a></dt> <dd>Exports all the scenes in the users's sketch folder </dd> <dt>drafting.visible <a href="/api/v1?drafting.visible" target="_blank">Try it</a></dt> <dd>Shows all strokes made with the drafting brush fully opaque </dd> <dt>drafting.transparent <a href="/api/v1?drafting.transparent" target="_blank">Try it</a></dt> <dd>Shows all strokes made with the drafting brush semi-transparent </dd> <dt>drafting.hidden <a href="/api/v1?drafting.hidden" target="_blank">Try it</a></dt> <dd>Hides all strokes made with the drafting brush </dd> <dt>load.user (int slot) <a href="/api/v1?load.user=2" target="_blank">Try it</a></dt> <dd>Loads the sketch from the user's sketch folder given an index (0 being most recent) </dd> <dt>load.featured (int slot) <a href="/api/v1?load.featured=2" target="_blank">Try it</a></dt> <dd>Loads the sketch in the given slot number from the featured sketch list </dd> <dt>load.liked (int slot) <a href="/api/v1?load.liked=2" target="_blank">Try it</a></dt> <dd>Loads the sketch in the given slot number from the user's liked sketches </dd> <dt>load.drive (int slot) <a href="/api/v1?load.drive=2" target="_blank">Try it</a></dt> <dd>Loads the sketch in the given slot number from the user's Google Drive </dd> <dt>load.named (string filename) <a href="/api/v1?load.named=Untitled_1" target="_blank">Try it</a></dt> <dd>Loads the sketch with the given name from the user's sketch folder </dd> <dt>merge.named (string filename) <a href="/api/v1?merge.named=Untitled_1" target="_blank">Try it</a></dt> <dd>Loads the sketch with the given name from the user's sketch folder </dd> <dt>new <a href="/api/v1?new" target="_blank">Try it</a></dt> <dd>Clears the current sketch </dd> <dt>symmetry.mirror <a href="/api/v1?symmetry.mirror" target="_blank">Try it</a></dt> <dd>Sets the symmetry mode to 'mirror' </dd> <dt>symmetry.multimirror <a href="/api/v1?symmetry.multimirror" target="_blank">Try it</a></dt> <dd>Sets the symmetry mode to 'multimirror' </dd> <dt>twohandeded.toggle <a href="/api/v1?twohandeded.toggle" target="_blank">Try it</a></dt> <dd>Toggles painting with both hands at once </dd> <dt>straightedge.toggle <a href="/api/v1?straightedge.toggle" target="_blank">Try it</a></dt> <dd>Toggles the straight edge tool on or off </dd> <dt>autoorient.toggle <a href="/api/v1?autoorient.toggle" target="_blank">Try it</a></dt> <dd>Toggles autoorientate on or off </dd> <dt>undo <a href="/api/v1?undo" target="_blank">Try it</a></dt> <dd>Undoes the last action </dd> <dt>redo <a href="/api/v1?redo" target="_blank">Try it</a></dt> <dd>Redo the last action </dd> <dt>panels.reset <a href="/api/v1?panels.reset" target="_blank">Try it</a></dt> <dd>Reset the position of all panels </dd> <dt>sketch.origin <a href="/api/v1?sketch.origin" target="_blank">Try it</a></dt> <dd>Enables the sketch origin tool </dd> <dt>viewonly.toggle <a href="/api/v1?viewonly.toggle" target="_blank">Try it</a></dt> <dd>Toggles 'view only' mode on or off </dd> <dt>spectator.toggle <a href="/api/v1?spectator.toggle" target="_blank">Try it</a></dt> <dd>Toggles the spectator camera </dd> <dt>spectator.on <a href="/api/v1?spectator.on" target="_blank">Try it</a></dt> <dd>Turns the spectator camera on </dd> <dt>spectator.off <a href="/api/v1?spectator.off" target="_blank">Try it</a></dt> <dd>Turns the spectator camera off </dd> <dt>autosimplify.toggle <a href="/api/v1?autosimplify.toggle" target="_blank">Try it</a></dt> <dd>Toggles 'auto-simplify' mode on or off </dd> <dt>export.current <a href="/api/v1?export.current" target="_blank">Try it</a></dt> <dd>Exports the current sketch to the user's Exports folder </dd> <dt>showfolder.sketch (int index) <a href="/api/v1?showfolder.sketch" target="_blank">Try it</a></dt> <dd>Opens the user's Sketches folder on the desktop </dd> <dt>guides.disable <a href="/api/v1?guides.disable" target="_blank">Try it</a></dt> <dd>Toggles guides on and off </dd> <dt>disco <a href="/api/v1?disco" target="_blank">Try it</a></dt> <dd>Starts a party </dd> <dt>selection.duplicate <a href="/api/v1?selection.duplicate" target="_blank">Try it</a></dt> <dd>Create a duplicate of the current selection (uses symmetry mirrors if active </dd> <dt>selection.delete <a href="/api/v1?selection.delete" target="_blank">Try it</a></dt> <dd>Deletes the current selection </dd> <dt>selection.group <a href="/api/v1?selection.group" target="_blank">Try it</a></dt> <dd>Groups (or ungroups) the current selection </dd> <dt>export.selected <a href="/api/v1?export.selected" target="_blank">Try it</a></dt> <dd>Exports the selected strokes to the user's Media Library </dd> <dt>camerapath.render <a href="/api/v1?camerapath.render" target="_blank">Try it</a></dt> <dd>Renders the current camera path to a video </dd> <dt>profiling.toggle <a href="/api/v1?profiling.toggle" target="_blank">Try it</a></dt> <dd>Toggles profiling mode on or off </dd> <dt>settings.toggle <a href="/api/v1?settings.toggle" target="_blank">Try it</a></dt> <dd>Toggles the settings panel on or off </dd> <dt>mirror.summon <a href="/api/v1?mirror.summon" target="_blank">Try it</a></dt> <dd>Summons the mirror origin to the user's position </dd> <dt>selection.invert <a href="/api/v1?selection.invert" target="_blank">Try it</a></dt> <dd>Inverts the current selection </dd> <dt>select.all <a href="/api/v1?select.all" target="_blank">Try it</a></dt> <dd>Selects all strokes and widgets on the current layer </dd> <dt>select.none <a href="/api/v1?select.none" target="_blank">Try it</a></dt> <dd>Deselects all strokes and widgets on the current layer </dd> <dt>selection.flip <a href="/api/v1?selection.flip" target="_blank">Try it</a></dt> <dd>Mirrors the current selection </dd> <dt>postprocessing.toggle <a href="/api/v1?postprocessing.toggle" target="_blank">Try it</a></dt> <dd>Toggles post-processing effects on or off </dd> <dt>watermark.toggle <a href="/api/v1?watermark.toggle" target="_blank">Try it</a></dt> <dd>Toggles the watermark on or off </dd> <dt>camerapath.togglevisuals <a href="/api/v1?camerapath.togglevisuals" target="_blank">Try it</a></dt> <dd>Toggles the camera path visuals on or off </dd> <dt>camerapath.togglepreview <a href="/api/v1?camerapath.togglepreview" target="_blank">Try it</a></dt> <dd>Toggles the camera path preview on or off </dd> <dt>camerapath.delete <a href="/api/v1?camerapath.delete" target="_blank">Try it</a></dt> <dd>Deletes the current camera path </dd> <dt>camerapath.record <a href="/api/v1?camerapath.record" target="_blank">Try it</a></dt> <dd>Starts recording a camera path </dd> <dt>camerapath.setactive (int index) <a href="/api/v1?camerapath.setactive" target="_blank">Try it</a></dt> <dd>Sets the active camera path </dd> <dt>stroke.delete (int index) <a href="/api/v1?stroke.delete=2" target="_blank">Try it</a></dt> <dd>Delete a stroke by index </dd> <dt>stroke.select (int index) <a href="/api/v1?stroke.select=2" target="_blank">Try it</a></dt> <dd>Select a stroke by index. </dd> <dt>strokes.select (int from, int to) <a href="/api/v1?strokes.select=1,4" target="_blank">Try it</a></dt> <dd>Select multiple strokes by index. </dd> <dt>selection.recolor (Boolean jitter) <a href="/api/v1?selection.recolor" target="_blank">Try it</a></dt> <dd>Recolors the currently selected strokes </dd> <dt>strokes.move.to (int start, int end, Vector3 position) <a href="/api/v1?strokes.move.to=1,2,5,12,-4" target="_blank">Try it</a></dt> <dd>Moves several strokes to the given position </dd> <dt>strokes.move.by (int start, int end, Vector3 translation) <a href="/api/v1?strokes.move.by=1,2,5,12,-4" target="_blank">Try it</a></dt> <dd>Moves several strokes to the given coordinates </dd> <dt>strokes.rotate.by (int start, int end, float angle) <a href="/api/v1?strokes.rotate.by=1,2,5,12,-4" target="_blank">Try it</a></dt> <dd>Rotates multiple brushstrokes around the current brush position </dd> <dt>strokes.scale.by (int start, int end, float scale) <a href="/api/v1?strokes.scale.by=1,2,0.5" target="_blank">Try it</a></dt> <dd>Scales multiple brushstrokes around the current brush position </dd> <dt>selection.rebrush (Boolean jitter) <a href="/api/v1?selection.rebrush=true" target="_blank">Try it</a></dt> <dd>Rebrushes the currently selected strokes </dd> <dt>selection.resize (Boolean jitter) <a href="/api/v1?selection.resize" target="_blank">Try it</a></dt> <dd>Changes the brush size the currently selected strokes </dd> <dt>selection.trim (int count) <a href="/api/v1?selection.trim=4" target="_blank">Try it</a></dt> <dd>Removes a number of points from the currently selected strokes </dd> <dt>selection.points.perlin (string axis, Vector3 scale) <a href="/api/v1?selection.points.perlin=y,0.5,2,0.5" target="_blank">Try it</a></dt> <dd>Moves the position of all control points in the selection using a noise function </dd> <dt>stroke.points.quantize (Vector3 grid) <a href="/api/v1?stroke.points.quantize=2,2,2" target="_blank">Try it</a></dt> <dd>Snaps all the points in selected strokes to a grid (buggy) </dd> <dt>stroke.join <a href="/api/v1?stroke.join" target="_blank">Try it</a></dt> <dd>Joins a stroke with the previous one </dd> <dt>strokes.join (int from, int to) <a href="/api/v1?strokes.join=1,4" target="_blank">Try it</a></dt> <dd>Joins all strokes between the two indices (inclusive) </dd> <dt>stroke.add (int index) <a href="/api/v1?stroke.add=2" target="_blank">Try it</a></dt> <dd>Adds a point at the current brush position to the specified stroke </dd> <dt>symmetry.type (string type) <a href="/api/v1?symmetry.type=wallpaper" target="_blank">Try it</a></dt> <dd>Sets the custom symmetry type (Currently either 'point' or 'wallpaper' </dd> <dt>symmetry.pointfamily (string family) <a href="/api/v1?symmetry.pointfamily=C4v" target="_blank">Try it</a></dt> <dd>Sets the custom point symmetry family (Any of Cn, Cnv, Cnh, Sn, Dn, Dnh, Dnd, T, Th, Td, O, Oh, I, Ih) Replace n with a number to also set the order. </dd> <dt>symmetry.wallpapergroup (string group) <a href="/api/v1?symmetry.wallpapergroup=p6m" target="_blank">Try it</a></dt> <dd>Sets the custom wallpaper symmetry group (Any of p1, pg, cm, pm, p6, p6m, p3, p3m1, p31m, p4, p4m, p4g, p2, pgg, pmg, pmm, cmm) </dd> <dt>symmetry.pointorder (int order) <a href="/api/v1?symmetry.pointorder=5" target="_blank">Try it</a></dt> <dd>Sets the custom point symmetry order </dd> <dt>symmetry.wallpaperrepeats (int x, int y) <a href="/api/v1?symmetry.wallpaperrepeats=4,4" target="_blank">Try it</a></dt> <dd>Sets the custom wallpaper symmetry repeats </dd> <dt>symmetry.wallpaperscale (float x, float y) <a href="/api/v1?symmetry.wallpaperscale=0.5,1" target="_blank">Try it</a></dt> <dd>Sets the custom wallpaper symmetry scale </dd> <dt>symmetry.wallpaperskew (float x, float y) <a href="/api/v1?symmetry.wallpaperskew=1,0.5" target="_blank">Try it</a></dt> <dd>Sets the custom wallpaper symmetry skew </dd> <dt>symmetry.colorshift.hue (string mode, float amplitude, float frequency) <a href="/api/v1?symmetry.colorshift.hue=Noise,1,2" target="_blank">Try it</a></dt> <dd>Sets the custom wallpaper color shift hue (mode is one of SineWave, SquareWave, SawtoothWave, TriangleWave, Noise) </dd> <dt>symmetry.colorshift.saturation (string mode, float amplitude, float frequency) <a href="/api/v1?symmetry.colorshift.saturation=SineWave,0.1,1" target="_blank">Try it</a></dt> <dd>Sets the custom wallpaper color shift saturation (mode is one of SineWave, SquareWave, SawtoothWave, TriangleWave, Noise) </dd> <dt>symmetry.colorshift.brightness (string mode, float amplitude, float frequency) <a href="/api/v1?symmetry.colorshift.brightness=SquareWave,0.5,6" target="_blank">Try it</a></dt> <dd>Sets the custom wallpaper color shift brightness (mode is one of SineWave, SquareWave, SawtoothWave, TriangleWave, Noise) </dd> <dt>multiplayer.join (string nickname, string roomName, Boolean isPrivate, int maxPlayers, Boolean silentRoom, Boolean viewOnlyRoom) <a href="/api/v1?multiplayer.join" target="_blank">Try it</a></dt> <dd>Joins a multiplayer room </dd> <dt>multiplayer.leave <a href="/api/v1?multiplayer.leave" target="_blank">Try it</a></dt> <dd>Leaves a multiplayer room </dd> <dt>tool.sketchsurface <a href="/api/v1?tool.sketchsurface" target="_blank">Try it</a></dt> <dd>Activates the SketchSurface </dd> <dt>tool.selection <a href="/api/v1?tool.selection" target="_blank">Try it</a></dt> <dd>Activates the Selection Tool </dd> <dt>tool.colorpicker <a href="/api/v1?tool.colorpicker" target="_blank">Try it</a></dt> <dd>Activates the Color Picker </dd> <dt>tool.brushpicker <a href="/api/v1?tool.brushpicker" target="_blank">Try it</a></dt> <dd>Activates the Brush Picker </dd> <dt>tool.brushandcolorpicker <a href="/api/v1?tool.brushandcolorpicker" target="_blank">Try it</a></dt> <dd>Activates the Brush And Color Picker </dd> <dt>tool.sketchorigin <a href="/api/v1?tool.sketchorigin" target="_blank">Try it</a></dt> <dd>Activates the SketchOrigin Tool </dd> <dt>tool.autogif <a href="/api/v1?tool.autogif" target="_blank">Try it</a></dt> <dd>Activates the AutoGif Tool </dd> <dt>tool.canvas <a href="/api/v1?tool.canvas" target="_blank">Try it</a></dt> <dd>Activates the Canvas Tool </dd> <dt>tool.transform <a href="/api/v1?tool.transform" target="_blank">Try it</a></dt> <dd>Activates the Transform Tool </dd> <dt>tool.stamp <a href="/api/v1?tool.stamp" target="_blank">Try it</a></dt> <dd>Activates the Stamp Tool </dd> <dt>tool.freepaint <a href="/api/v1?tool.freepaint" target="_blank">Try it</a></dt> <dd>Activates the FreePaint Tool </dd> <dt>tool.eraser <a href="/api/v1?tool.eraser" target="_blank">Try it</a></dt> <dd>Activates the Eraser Tool </dd> <dt>tool.screenshot <a href="/api/v1?tool.screenshot" target="_blank">Try it</a></dt> <dd>Activates the Screenshot Tool </dd> <dt>tool.dropper <a href="/api/v1?tool.dropper" target="_blank">Try it</a></dt> <dd>Activates the Dropper Tool </dd> <dt>tool.saveicon <a href="/api/v1?tool.saveicon" target="_blank">Try it</a></dt> <dd>Activates the SaveIcon Tool </dd> <dt>tool.threedofviewing <a href="/api/v1?tool.threedofviewing" target="_blank">Try it</a></dt> <dd>Activates the ThreeDofViewing Tool </dd> <dt>tool.multicam <a href="/api/v1?tool.multicam" target="_blank">Try it</a></dt> <dd>Activates the MultiCam Tool </dd> <dt>tool.teleport <a href="/api/v1?tool.teleport" target="_blank">Try it</a></dt> <dd>Activates the Teleport Tool </dd> <dt>tool.repaint <a href="/api/v1?tool.repaint" target="_blank">Try it</a></dt> <dd>Activates the Repaint Tool </dd> <dt>tool.recolor <a href="/api/v1?tool.recolor" target="_blank">Try it</a></dt> <dd>Activates the Recolor Tool </dd> <dt>tool.rebrush <a href="/api/v1?tool.rebrush" target="_blank">Try it</a></dt> <dd>Activates the Rebrush Tool </dd> <dt>tool.pin <a href="/api/v1?tool.pin" target="_blank">Try it</a></dt> <dd>Activates the Pin Tool </dd> <dt>tool.camerapath <a href="/api/v1?tool.camerapath" target="_blank">Try it</a></dt> <dd>Activates the CameraPath Tool </dd> <dt>tool.fly <a href="/api/v1?tool.fly" target="_blank">Try it</a></dt> <dd>Activates the Fly Tool </dd> <dt>snap.angle (string angle) <a href="/api/v1?snap.angle=15" target="_blank">Try it</a></dt> <dd>Sets the current snapping angle. Angle must be a supported value (15, 30, 45, 60, 75 or 90) </dd> <dt>snap.grid (string size) <a href="/api/v1?snap.grid=5" target="_blank">Try it</a></dt> <dd>Sets the current snapping grid. Size must be a supported value (0.1, 0.25, 0.5 ,1, 2, 3, 5 </dd> <dt>selection.snap.angles <a href="/api/v1?selection.snap.angles" target="_blank">Try it</a></dt> <dd>Applies the current snap angle to all selected objects </dd> <dt>selection.snap.positions <a href="/api/v1?selection.snap.positions" target="_blank">Try it</a></dt> <dd>Applies the current snap grid to all selected objects </dd> <dt>selection.align (string axis, string alignBy) <a href="/api/v1?selection.align=x,center" target="_blank">Try it</a></dt> <dd>Aligns all selected objects to the given axis using their minimum, center or maximum points </dd> <dt>listenfor.strokes (string url) <a href="/api/v1?listenfor.strokes=http://localhost:8000/" target="_blank">Try it</a></dt> <dd>Adds the url of an app that wants to receive the data for a stroke as each one is finished </dd> <dt>showfolder.scripts <a href="/api/v1?showfolder.scripts" target="_blank">Try it</a></dt> <dd>Opens the user's Scripts folder on the desktop </dd> <dt>showfolder.exports <a href="/api/v1?showfolder.exports" target="_blank">Try it</a></dt> <dd>Opens the user's Exports folder on the desktop </dd> <dt>spectator.move.to (Vector3 position) <a href="/api/v1?spectator.move.to=1,1,1" target="_blank">Try it</a></dt> <dd>Moves the spectator camera to the given position </dd> <dt>spectator.move.by (Vector3 amount) <a href="/api/v1?spectator.move.by=1,1,1" target="_blank">Try it</a></dt> <dd>Moves the spectator camera by the given amount </dd> <dt>user.move.to (Vector3 position) <a href="/api/v1?user.move.to=1,1,1" target="_blank">Try it</a></dt> <dd>Moves the user to the given position </dd> <dt>user.move.by (Vector3 amount) <a href="/api/v1?user.move.by=1,1,1" target="_blank">Try it</a></dt> <dd>Moves the user by the given amount </dd> <dt>spectator.turn.y (float angle) <a href="/api/v1?spectator.turn.y=45" target="_blank">Try it</a></dt> <dd>Rotates the spectator camera left or right. </dd> <dt>spectator.turn.x (float angle) <a href="/api/v1?spectator.turn.x=45" target="_blank">Try it</a></dt> <dd>Rotates the spectator camera up or down. </dd> <dt>spectator.turn.z (float angle) <a href="/api/v1?spectator.turn.z=45" target="_blank">Try it</a></dt> <dd>Tilts the angle of the spectator camera clockwise or anticlockwise. </dd> <dt>user.turn.y (float angle) <a href="/api/v1?user.turn.y=45" target="_blank">Try it</a></dt> <dd>Rotates the user camera left or right. </dd> <dt>user.turn.x (float angle) <a href="/api/v1?user.turn.x=45" target="_blank">Try it</a></dt> <dd>Rotates the user camera up or down. (monoscopic mode only) </dd> <dt>user.turn.z (float angle) <a href="/api/v1?user.turn.z=45" target="_blank">Try it</a></dt> <dd>Tilts the angle of the user camera clockwise or anticlockwise. (monoscopic mode only) </dd> <dt>scene.scale.to (float scale) <a href="/api/v1?scene.scale.to=0.5" target="_blank">Try it</a></dt> <dd>Sets the scene scale to the given value </dd> <dt>scene.scale.by (float amount) <a href="/api/v1?scene.scale.by=1.5" target="_blank">Try it</a></dt> <dd>Scales the scene by the given amount </dd> <dt>spectator.direction (Vector3 direction) <a href="/api/v1?spectator.direction=45,45,0" target="_blank">Try it</a></dt> <dd>Points the spectator camera to look in the specified direction. Angles are given in x,y,z degrees </dd> <dt>user.direction (Vector3 direction) <a href="/api/v1?user.direction=45,45,0" target="_blank">Try it</a></dt> <dd>Points the user camera to look in the specified direction. Angles are given in x,y,z degrees. (Monoscopic mode only) </dd> <dt>spectator.look.at (Vector3 position) <a href="/api/v1?spectator.look.at=1,2,3" target="_blank">Try it</a></dt> <dd>Points the spectator camera towards a specific point </dd> <dt>user.look.at (Vector3 direction) <a href="/api/v1?user.look.at=1,2,3" target="_blank">Try it</a></dt> <dd>Points the user camera towards a specific point (In VR this only changes the y axis. In monoscopic mode it changes all 3 axes) </dd> <dt>spectator.mode (string mode) <a href="/api/v1?spectator.mode=stationary" target="_blank">Try it</a></dt> <dd>Sets the spectator camera mode to one of stationary, slowFollow, wobble, circular </dd> <dt>spectator.hide (string thing) <a href="/api/v1?spectator.hide=panels" target="_blank">Try it</a></dt> <dd>Hides the chosen type of elements from the spectator camera (widgets, strokes, selection, headset, panels, ui </dd> <dt>brush.move.to (Vector3 position) <a href="/api/v1?brush.move.to=widgets" target="_blank">Try it</a></dt> <dd>Moves the brush to the given coordinates </dd> <dt>brush.move.to.hand (string hand, Boolean alsoRotate) <a href="/api/v1?brush.move.to.hand=r" target="_blank">Try it</a></dt> <dd>Moves the brush to the given hand (l or r </dd> <dt>brush.move.by (Vector3 offset) <a href="/api/v1?brush.move.by=1,1,1" target="_blank">Try it</a></dt> <dd>Moves the brush by the given amount </dd> <dt>brush.move (float distance) <a href="/api/v1?brush.move=1" target="_blank">Try it</a></dt> <dd>Moves the brush forward by 'distance' without drawing a line </dd> <dt>brush.draw (float distance) <a href="/api/v1?brush.draw=2" target="_blank">Try it</a></dt> <dd>Moves the brush forward by 'distance' and draws a line </dd> <dt>brush.turn.y (float angle) <a href="/api/v1?brush.turn.y=45" target="_blank">Try it</a></dt> <dd>Changes the brush direction to the left or right. Angle is measured in degrees </dd> <dt>brush.turn.x (float angle) <a href="/api/v1?brush.turn.x=45" target="_blank">Try it</a></dt> <dd>Changes the brush direction up or down. Angle is measured in degrees </dd> <dt>brush.turn.z (float angle) <a href="/api/v1?brush.turn.z=45" target="_blank">Try it</a></dt> <dd>Rotates the brush clockwise or anticlockwise. Angle is measured in degrees </dd> <dt>brush.look.at (Vector3 direction) <a href="/api/v1?brush.look.at=1,2,3" target="_blank">Try it</a></dt> <dd>Changes the brush direction to look at the specified point </dd> <dt>brush.look.forwards <a href="/api/v1?brush.look.forwards" target="_blank">Try it</a></dt> <dd>Changes the brush direction to look forwards </dd> <dt>brush.look.up <a href="/api/v1?brush.look.up" target="_blank">Try it</a></dt> <dd>Changes the brush direction to look upwards </dd> <dt>brush.look.down <a href="/api/v1?brush.look.down" target="_blank">Try it</a></dt> <dd>Changes the brush direction to look downwards </dd> <dt>brush.look.left <a href="/api/v1?brush.look.left" target="_blank">Try it</a></dt> <dd>Changes the brush direction to look to the left </dd> <dt>brush.look.right <a href="/api/v1?brush.look.right" target="_blank">Try it</a></dt> <dd>Changes the brush direction to look to the right </dd> <dt>brush.look.backwards <a href="/api/v1?brush.look.backwards" target="_blank">Try it</a></dt> <dd>Changes the brush direction to look backwards </dd> <dt>brush.home.reset <a href="/api/v1?brush.home.reset" target="_blank">Try it</a></dt> <dd>Resets the brush position and direction </dd> <dt>brush.home.set <a href="/api/v1?brush.home.set" target="_blank">Try it</a></dt> <dd>Sets the current brush position and direction as the new home. This persists in new sketches </dd> <dt>brush.transform.push <a href="/api/v1?brush.transform.push" target="_blank">Try it</a></dt> <dd>Stores the current brush position and direction on to a stack </dd> <dt>brush.transform.pop <a href="/api/v1?brush.transform.pop" target="_blank">Try it</a></dt> <dd>Pops the most recent current brush position and direction from the stack </dd> <dt>debug.brush <a href="/api/v1?debug.brush" target="_blank">Try it</a></dt> <dd>Logs some info about the brush </dd> <dt>text.add (string text) <a href="/api/v1?text.add=Hello world!" target="_blank">Try it</a></dt> <dd>Adds a text widget to the sketch </dd> <dt>video.import (string location) <a href="/api/v1?video.import=animated-logo.mp4" target="_blank">Try it</a></dt> <dd>Imports a video given a url or a filename in Media Library\Videos </dd> <dt>skybox.import (string location) <a href="/api/v1?skybox.import=panorama.jpg" target="_blank">Try it</a></dt> <dd>Sets the skybox from either a url or a filename in Media Library\BackgroundImages (Images loaded from a url are saved locally first) </dd> <dt>image.import (string location) <a href="/api/v1?image.import=OpenBrushLogo.png" target="_blank">Try it</a></dt> <dd>Imports an image given a url or a filename in Media Library\Images (Images loaded from a url are saved locally first) </dd> <dt>environment.type (string name) <a href="/api/v1?environment.type=pistachio" target="_blank">Try it</a></dt> <dd>Sets the current environment </dd> <dt>panel.open (string name, float x, float y, float z) <a href="/api/v1?panel.open=scripts,4,12,4" target="_blank">Try it</a></dt> <dd>Opens a given panel at the given position </dd> <dt>panel.close (string name) <a href="/api/v1?panel.close=scripts" target="_blank">Try it</a></dt> <dd>Closes a given panel </dd> <dt>panel.position (string name, Vector3 position) <a href="/api/v1?panel.position=4,12,4" target="_blank">Try it</a></dt> <dd>Sets position of a given panel </dd> <dt>panel.rotation (string name, Vector3 rotation) <a href="/api/v1?panel.rotation=4,12,4" target="_blank">Try it</a></dt> <dd>Sets rotation of a given panel </dd> <dt>strokes.debug <a href="/api/v1?strokes.debug" target="_blank">Try it</a></dt> <dd>Logs some debug info about the strokes </dd> <dt>panel.attach (string name) <a href="/api/v1?panel.attach=scripts" target="_blank">Try it</a></dt> <dd>Attaches the given panel to the user's wand </dd> <dt>panel.detach (string name, Vector3 position) <a href="/api/v1?panel.detach=scripts" target="_blank">Try it</a></dt> <dd>Detaches the given panel from the user's wand </dd> <dt>layer.add <a href="/api/v1?layer.add" target="_blank">Try it</a></dt> <dd>Adds a new layer </dd> <dt>layer.clear (int layer) <a href="/api/v1?layer.clear=2" target="_blank">Try it</a></dt> <dd>Clears the contents of a layer </dd> <dt>debug.ram (Boolean active) <a href="/api/v1?debug.ram" target="_blank">Try it</a></dt> <dd>Enable/Disable logging of RAM usage to the in-app console (Android only) </dd> <dt>layer.delete (int layer) <a href="/api/v1?layer.delete=1" target="_blank">Try it</a></dt> <dd>Deletes a layer </dd> <dt>layer.squash (int squashedLayer, int destinationLayer) <a href="/api/v1?layer.squash=1,0" target="_blank">Try it</a></dt> <dd>Move everything from one layer to another then removes the empty layer </dd> <dt>layer.activate (int layer) <a href="/api/v1?layer.activate=2" target="_blank">Try it</a></dt> <dd>Make a layer the active layer </dd> <dt>layer.show (int layer) <a href="/api/v1?layer.show=2" target="_blank">Try it</a></dt> <dd>Make a layer visible </dd> <dt>layer.hide (int layer) <a href="/api/v1?layer.hide=2" target="_blank">Try it</a></dt> <dd>Hide a layer </dd> <dt>layer.toggle (int layer) <a href="/api/v1?layer.toggle=2" target="_blank">Try it</a></dt> <dd>Toggles a layer between visible and hidden </dd> <dt>model.select (int index) <a href="/api/v1?model.select=2" target="_blank">Try it</a></dt> <dd>Selects a 3d model by index. </dd> <dt>model.position (int index, Vector3 position) <a href="/api/v1?model.position=2,6,8" target="_blank">Try it</a></dt> <dd>Move a 3d model to the given coordinates </dd> <dt>model.rotation (int index, Vector3 rotation) <a href="/api/v1?model.rotation" target="_blank">Try it</a></dt> <dd>Set a model's rotation to the given angles </dd> <dt>model.scale (int index, float scale) <a href="/api/v1?model.scale" target="_blank">Try it</a></dt> <dd>Set a model's scale to the amount </dd> <dt>symmetry.position (Vector3 position) <a href="/api/v1?symmetry.position=2,6,8" target="_blank">Try it</a></dt> <dd>Move the symmetry widget to the given coordinates </dd> <dt>symmetry.set.rotation (Vector3 rotation) <a href="/api/v1?symmetry.set.rotation=45,30,0" target="_blank">Try it</a></dt> <dd>Sets the symmetry widget rotation </dd> <dt>symmetry.set.transform (Vector3 position, Vector3 rotation) <a href="/api/v1?symmetry.set.transform=2,6,8,45,30,0" target="_blank">Try it</a></dt> <dd>Sets the position and rotation of the symmetry widget </dd> <dt>brush.force.painting.on (Boolean active) <a href="/api/v1?brush.force.painting.on=true" target="_blank">Try it</a></dt> <dd>Turns on or off an override that paints even if the trigger is not pressed. </dd> <dt>brush.force.painting.off (Boolean active) <a href="/api/v1?brush.force.painting.off=false" target="_blank">Try it</a></dt> <dd>Turns on or off an override that stops the user painting even if the trigger is pressed. </dd> <dt>brush.new.stroke <a href="/api/v1?brush.new.stroke" target="_blank">Try it</a></dt> <dd>Ends the current stroke and starts a new one next frame </dd> <dt>image.select (int index) <a href="/api/v1?image.select=2" target="_blank">Try it</a></dt> <dd>Selects an image by index. </dd> <dt>image.delete (int index) <a href="/api/v1?image.delete=2" target="_blank">Try it</a></dt> <dd>Deletes an image by index. </dd> <dt>video.delete (int index) <a href="/api/v1?video.delete=2" target="_blank">Try it</a></dt> <dd>Deletes a video by index. </dd> <dt>model.delete (int index) <a href="/api/v1?model.delete=2,6,8" target="_blank">Try it</a></dt> <dd>Deletes a 3d model by index. </dd> <dt>guide.delete (int index) <a href="/api/v1?guide.delete=2" target="_blank">Try it</a></dt> <dd>Deletes a guide by index. </dd> <dt>image.position (int index, Vector3 position) <a href="/api/v1?image.position=2,1,6,8" target="_blank">Try it</a></dt> <dd>Move an image to the given coordinates </dd> <dt>image.rotation (int index, Vector3 rotation) <a href="/api/v1?image.rotation" target="_blank">Try it</a></dt> <dd>Set a images rotation to the given angles </dd> <dt>image.scale (int index, float scale) <a href="/api/v1?image.scale" target="_blank">Try it</a></dt> <dd>Set a images scale to the amount </dd> <dt>light.position (int index, Vector3 position) <a href="/api/v1?light.position" target="_blank">Try it</a></dt> <dd>Move a light to the given coordinates </dd> <dt>light.rotation (int index, Vector3 rotation) <a href="/api/v1?light.rotation" target="_blank">Try it</a></dt> <dd>Set a light's rotation to the given angles </dd> <dt>image.formEncode (int index) <a href="/api/v1?image.formEncode=2" target="_blank">Try it</a></dt> <dd>Converts an image to a string suitable for use in a form </dd> <dt>image.base64Decode (string base64, string filename) <a href="/api/v1?image.base64Decode" target="_blank">Try it</a></dt> <dd>Saves an image based on a base64 encoded string </dd> <dt>scripts.initPluginScripting <a href="/api/v1?scripts.initPluginScripting=" target="_blank">Try it</a></dt> <dd>Call this before using any HTTP endpoint that accesses plugins (including html pages that list plugins) </dd> <dt>scripts.toolscript.activate (string scriptName) <a href="/api/v1?scripts.toolscript.activate=Spiral" target="_blank">Try it</a></dt> <dd>Activate the given tool script </dd> <dt>scripts.toolscript.deactivate <a href="/api/v1?scripts.toolscript.deactivate=Spiral" target="_blank">Try it</a></dt> <dd>Dectivate the tool script </dd> <dt>scripts.symmetryscript.activate (string scriptName) <a href="/api/v1?scripts.symmetryscript.activate=Boids" target="_blank">Try it</a></dt> <dd>Activate the given symmetry script </dd> <dt>scripts.symmetryscript.deactivate <a href="/api/v1?scripts.symmetryscript.deactivate=Boids" target="_blank">Try it</a></dt> <dd>Dectivate the symmetry script </dd> <dt>scripts.pointerscript.activate (string scriptName) <a href="/api/v1?scripts.pointerscript.activate=Loops" target="_blank">Try it</a></dt> <dd>Activate the given pointer script </dd> <dt>scripts.pointerscript.deactivate <a href="/api/v1?scripts.pointerscript.deactivate=Loops" target="_blank">Try it</a></dt> <dd>Dectivate the pointer script </dd> <dt>scripts.backgroundscript.activate (string scriptName) <a href="/api/v1?scripts.backgroundscript.activate=Lines" target="_blank">Try it</a></dt> <dd>Activate the given background script </dd> <dt>scripts.backgroundscript.deactivate (string scriptName) <a href="/api/v1?scripts.backgroundscript.deactivate=Lines" target="_blank">Try it</a></dt> <dd>Dectivate the given background script </dd> <dt>scripts.backgroundscript.activateall <a href="/api/v1?scripts.backgroundscript.activateall" target="_blank">Try it</a></dt> <dd>Dectivate all background scripts </dd> <dt>scripts.backgroundscript.deactivateall <a href="/api/v1?scripts.backgroundscript.deactivateall" target="_blank">Try it</a></dt> <dd>Dectivate all background scripts </dd> <dt>guide.add (string type) <a href="/api/v1?guide.add=cube" target="_blank">Try it</a></dt> <dd>Adds a guide to the scene (cube, sphere, capsule, cone, ellipsoid) </dd> <dt>guide.select (int index) <a href="/api/v1?guide.select=2" target="_blank">Try it</a></dt> <dd>Selects a guide by index. </dd> <dt>guide.position (int index, Vector3 position) <a href="/api/v1?guide.position=2,4,10,-4" target="_blank">Try it</a></dt> <dd>Move a guide to the given coordinates </dd> <dt>guide.scale (int index, Vector3 scale) <a href="/api/v1?guide.scale=2,1.5,1,1.5" target="_blank">Try it</a></dt> <dd>Sets the (non-uniform) scale of a guide </dd> </dl> </body></html>

Latest Blog Posts

Code Execution with MCP: Architecting Agentic Efficiency
By Om-Shree-0709 on December 14, 2025.
Model Context Protocol Proxies: Enabling Enterprise Control with Virtual MCPs
By Om-Shree-0709 on December 9, 2025.
AI Security
Virtual MCP
Kubernetes Operator
The State of MCP in 2025: Who's Building What and Why It Matters
By punkpeye on December 7, 2025.
mcp
startups

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/moz411/openbrush-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server