API Commands List
This page was generated from the output directly from Open Brush API server. It's not always totally up to date. When you're running Open Brush then use the live commands list you get from http://localhost:40074/help/commands as that will always be current.
The "Try It" links assume that a version of Open Brush with API support is currently running on this computer. They won't work if Open Brush isn't running. You can run a monoscopic version if you don't have a VR headset attached.
Commands are query string parameters. Like this: command.name=parameters
Separate multiple commands with: &
If you want to send a lot of commands or especially long commands (complex paths etc) then you can just http POST instead of GET. The commands should be form-encoded in the body of the request (exactly as if you submitted a html form with the form name as the command name and the form value as the command parameters)
You can also send multiple requests although because of the nature of http, these can sometimes arrive in a different order to how yousent them. We will soon support websockets which should be a better way to send realtime streams of commands.
Draws a series of paths at the current brush position [[[x1,y1,z1],[x2,y2,z2], etc...]]. Does not move the brush position
Draws a path at the current brush position [[x1,y1,z1],[x2,y2,z2], etc...]. Does not move the brush position
Draws a polygon at the current brush position. Does not move the brush position
Opens the user's Scripts folder on the desktop
Opens the user's Exports folder on the desktop
Draws the characters supplied at the current brush position
Draws the path supplied as an SVG Path string at the current brush position
Changes the brush. brushType can either be the brush name or it's guid. brushes are listed in the localhost:40074/help screen
Adds the supplied values to the current color. Values are hue, saturation and value
Adds the supplied values to the current color. Values are red green and blue
Sets the current color. Values are hue, saturation and value
Sets the current color. Values are red, green and blue
Sets the current color. colorString can either be a hex value or a css color name.
Sets the current brush size
Changes the current brush size by 'amount'
Moves the spectator or non-VR camera to the given position
Moves the spectator or non-VR camera by the given amount
Turns the spectator or non-VR camera left or right.
Changes the angle of the spectator or non-VR camera up or down.
Tilts the angle of the spectator or non-VR camera clockwise or anticlockwise.
Points the spectator or non-VR camera to look in the specified direction. Angles are given in x,y,z degrees
Moves the brush to the given coordinates
Moves the brush by the given amount
Moves the brush forward by 'distance' without drawing a line
Moves the brush forward by 'distance' and draws a line
Changes the brush direction to the left or right. Angle is measured in degrees
Changes the brush direction up or down. Angle is measured in degrees
Rotates the brush clockwise or anticlockwise. Angle is measured in degrees
Changes the brush direction to look at the specified point
Changes the brush direction to look forwards
Changes the brush direction to look upwards
Changes the brush direction to look downwards
Changes the brush direction to look to the left
Changes the brush direction to look to the right
Changes the brush direction to look backwards
Resets the brush position and direction
Sets the current brush position and direction as the new home
Stores the current brush position and direction on to a stack
Pops the most recent current brush position and direction from the stack
Logs some info about the brush
Delete strokes by their index. If index is 0 the most recent stroke is deleted. -1 etc steps back in time
Selects a stroke by it's index. 0 is the most recent stroke, -1 is second to last, 1 is the first.
Select multiple strokes by their index. 0 is the most recent stroke, -1 is second to last, 1 is the first.
Recolors the currently selected strokes
Rebrushes the currently selected strokes
Changes the brush size the currently selected strokes
Removes a number of points from the currently selected strokes
Moves the position of all control points in the selection using a noise function
Snaps all the points in selected strokes to a grid (buggy)
Joins a stroke with the previous one
Joins all strokes between the two indices (inclusive)
Adds a point at the current brush position to the specified stroke
Activates the SketchSurface
Activates the Selection Tool
Activates the Color Picker
Activates the Brush Picker
Activates the Brush And Color Picker
Activates the SketchOrigin Tool
Activates the AutoGif Tool
Activates the Canvas Tool
Activates the Transform Tool
Activates the Stamp Tool
Activates the FreePaint Tool
Activates the Eraser Tool
Activates the Screenshot Tool
Activates the Dropper Tool
Activates the SaveIcon Tool
Activates the ThreeDofViewing Tool
Activates the MultiCam Tool
Activates the Teleport Tool
Activates the Repaint Tool
Activates the Recolor Tool
Activates the Rebrush Tool
Activates the Pin Tool
Activates the CameraPath Tool
Activates the Fly Tool
Save the current scene overwriting the last save if it exists
Saves the current scene in a new slot
Exports all the scenes in the users's sketch folder
Shows all strokes made with the drafting brush fully opaque
Shows all strokes made with the drafting brush semi-transparent
Hides all strokes made with the drafting brush
Loads the sketch in the given slot number from the user's sketch folder
Loads the sketch in the given slot number from the curated sketch list
Loads the sketch in the given slot number from the user's liked sketches
Loads the sketch in the given slot number from the user's Google Drive
Loads the sketch with the given name from the user's sketch folder
Clears the current sketch
Sets the symmetry mode to 'mirror'
Sets the symmetry mode to 'double mirror'
Toggles the straight edge tool on or off
Toggles autoorientate on or off
Undoes the last action
Redo the last action
Reset the position of all panels
Enables the sketch origin tool
Toggles 'view only' mode on or off
Toggles the Drop Cam widget on or off
Toggles 'auto-simplify' mode on or off
Exports the current sketch to the user's Exports folder
Opens the user's Sketches folder on the desktop
Disables all stencils
Starts a party
Create a duplicate of the current selection
Groups the current selection
Exports the selected strokes to the user's Media Library
Renders the current camera path to a video
Toggles profiling mode on or off
Toggles the settings panel on or off
Summons the mirror origin to the user's position
Inverts the current selection
Selects all strokes and widgets in the scene
Mirrors the current selection
Toggles post-processing effects on or off
Toggles the watermark on or off
Toggles the camera path visuals on or off
Toggles the camera path preview on or off
Deletes the current camera path
Starts recording a camera path
Last modified 4mo ago