Create a rectangular sketch in a Part Studio with optional variable references

Create an extrude feature from a sketch

Create a thicken feature from a sketch

Get all variables from a Part Studio variable table

Set or update a variable in a Part Studio variable table

Get all features from a Part Studio

Delete a feature from a Part Studio or Assembly

List documents in your Onshape account with optional filtering and sorting

Search for documents by name or description

Get detailed information about a specific document

Get a comprehensive summary of a document including all workspaces and elements

Find Part Studio elements in a specific workspace, optionally filtered by name

Get all parts from a Part Studio element

Get all elements (Part Studios, Assemblies, etc.) in a workspace

Get assembly structure including instances and occurrences

Create a new Onshape document

Create a new Part Studio in an existing document

Create a new Assembly in an existing document

Add a part or sub-assembly instance to an assembly

Apply a RELATIVE transform to an assembly instance (inches and degrees). Note: fails on fixed/grounded instances — use get_assembly_positions to check the 'fixed' flag first.

Create a fastened (rigid) mate between two assembly instances. Requires face IDs from Part Studio body details to place mate connectors on specific faces. Optional offsets shift connectors from face centers (in the face's local XY plane + Z along normal).

Create a revolute (rotation) mate between two assembly instances. The first instance rotates relative to the second around the mate connector Z-axis. Requires face IDs from Part Studio body details. Optional offsets shift connectors from face centers.

Create a slider (linear motion) mate between two assembly instances. The first instance slides relative to the second — positive travel moves the first instance along the face normal direction away from the second. Swap instance order to reverse slide direction. Requires face IDs from Part Studio body details. Optional offsets shift connectors from face centers.

Create a cylindrical (slide + rotate) mate between two assembly instances. The first instance slides and rotates relative to the second along the mate connector Z-axis. Requires face IDs from Part Studio body details. Optional offsets shift connectors from face centers.

Create an explicit mate connector on a face of an assembly instance. The connector is placed at the face center with its Z-axis along the face normal. Offsets are in the connector's LOCAL coordinate system (X/Y in-plane, Z along normal). Flipping the Z-axis also reverses the other axes via the right-hand rule, which affects how offset translations map to world space.

Create a circular sketch on a standard plane

Create a line sketch on a standard plane

Create an arc sketch on a standard plane

Create a fillet (rounded edge) on one or more edges

Create a chamfer (beveled edge) on one or more edges

Create a revolve feature by rotating a sketch around an axis

Create a linear pattern of features

Create a circular pattern of features around an axis

Perform a boolean operation (union, subtract, intersect) on bodies

Evaluate a FeatureScript expression in a Part Studio (read-only, for querying geometry)

Get the tight bounding box of all parts in a Part Studio

Export a Part Studio to STL, STEP, or other format

Export an Assembly to STL, STEP, or other format

Check for overlapping/interfering parts in an assembly using bounding box detection. Returns which parts overlap and by how much.

Get positions, sizes, and world-space bounds of all instances in an assembly (in inches)

Set an instance to an ABSOLUTE position in inches (unlike transform_instance which is relative). Resets rotation to identity. Note: fails on fixed/grounded instances (API returns 400).

Position source instance flush against a face of target instance. Faces: front (min Y), back (max Y), left (min X), right (max X), bottom (min Z), top (max Z). Only moves the perpendicular axis; other axes stay unchanged.

Get face-level geometry details for all parts in a Part Studio. Returns face deterministic IDs, surface types (PLANE, CYLINDER, etc.), and for planar faces: normal vectors and origin points. Use face IDs with mate connector tools.

Get all features (mates, mate connectors, etc.) from an assembly with their current state (OK, ERROR, SUPPRESSED). Useful for inspecting existing mates and debugging assembly issues.

Query the true outward-facing coordinate system for a face on an assembly instance. Returns the guaranteed outward normal (Z-axis), tangent axes (X/Y), and origin. More reliable than body details normals. Use this to verify face orientations before creating mates.