Skip to content

Tool server (MCP) tools ​

What an assistant connected to the tool server can call: 168 tools. The default list is the core pack, at most 10 tools; every other family is opt-in. The script API is the product: an assistant works by writing a script (the kit), not by calling many tools. ? marks an optional input.

MutinyBIM core ​

Family core: Write, check, preview and land scripts that read and change the model, save a part script's parts, and four reads to look before writing.

Turn it on: /mcp (the default list).

bim_script_reference ​

Start here before writing a MutinyBIM script; read the index once per thread. No arguments: whether scripts can run here, the example scripts, the workflow, the kit's functions by name. search: a topic ("rooftop unit", "drain slope", "sheet per level"). topic: one function or recipe by name, whole. example: one whole example script ("rooftop-unit", "small-office", "plumbing-riser", "electrical-room"). command: one ctx.edit command's fields. library: list or read saved scripts.

Input: example?, search?, topic?, command?, library?, key?, version?

bim_check_output ​

Lint and syntax of a script with line numbers, kit calls and commands that don't exist, and what its reads send (with model_id); or the kernel's checks on an output. Runs and saves nothing. The answer's script_id names the script in later calls.

Input: project_id?, model_id?, level?, zone?, script?, selection?, output?

bim_run_script ​

Preview: run a script on this thread's sealed machine (no network, 1 GB, 30 s, 2 MB) and check its output. Saves nothing; returns what would change, apply_with and script_id (send the id, not the text, next time).

Input: project_id?, model_id?, level?, zone?, script, values?, selection?

bim_apply_output ​

Land bim_run_script's apply_with.args (unchanged) as one undo step after the person approves; re-runs and lands only what was previewed. Outside clients send output + provenance instead of script.

Input: project_id?, model_id, level?, zone?, base_revision, script?, output?, provenance?, values?, selection?, output_hash, label, steps, changes, approval

bim_save_part_type ​

Save bim_run_script's part types (apply_with.args) and the script version to the firm library after the person approves; re-runs and saves only what was previewed.

Input: project_id?, model_id?, script, values?, output_hash, parts, save_as?

bim_model_summary ​

Counts by element kind, the areas (level / zone / discipline) the model has, systems with their total airflow, open validation issues, the Not placed yet list (parts that exist before they are drawn, each with its circuit), open questions and assumptions, and the revision this was read at. Start here, then read one area at a time.

Input: project_id?, model_id, level?, zone?, questions?

bim_query_elements ​

List elements by kind, class, area and discipline with the facts needed to plan an edit (sizes in inches, lengths and positions in feet, airflow in CFM). Returns the revision read and the total matched. Filter by level/zone on large models.

Input: project_id?, model_id, level?, zone?, kinds?, class?, discipline?, ids?, limit?, why?, if_removed?

bim_inspect_network ​

For one element: what it connects to, and the path from it up to its equipment with airflow on each piece. Use before editing a branch, run or terminal.

Input: project_id?, model_id, level?, zone?, element_id

bim_validation_issues ​

Open validation issues (disconnected connectors, undersized branches, …) with the elements involved and the revision read.

Input: project_id?, model_id, level?, zone?, limit?

Model reads and everyday edits ​

Family model: Schedule rows, levels, views and sheets, linked models, surfaces; previews and the everyday part edits; pictures, printing and issuing sheets; coordination lint.

Turn it on: /packs/model/mcp, --packs model, or bim_enable_pack in a session.

bim_schedule_read ​

Rows of a schedule view (or an ad hoc v2 definition): columns with unit and whether a cell edits per instance or per type, rows as [row_key, ...cells] (limit ≤200 from offset), totals, and explain text for locked cells. Panel/feeder form schedules return what prints. No schedule: lists schedule views. Read-only.

Input: project_id, model_id, schedule?, definition?, offset?, limit?, columns?, explain?

bim_list_part_types ​

Part types you can place, in every discipline: the model's own types first, then the starter library's. Each lists its type values, the instance parameters you can set (with units and choices) and its connectors. Also returns the model's levels. Read this before bim_place_part.

Input: project_id, model_id, category?, search?, limit?

bim_list_levels ​

The model's levels (name, elevation in feet, and the linked storey a level was made from), and for each linked model its storeys placed where the model shows them, with what bim_sync_linked_levels would do to each. Read this before adding, moving or syncing levels.

Input: project_id, model_id

bim_list_views_and_sheets ​

Every view (plan, ceiling plan, section, 3D, detail view) with its level, scale and the sheet it is on, and every sheet with its viewports, notes and live blocks (text now, unresolved fields). Use before creating or placing so you reuse names and ids.

Input: project_id, model_id

bim_list_linked_models ​

The models linked under this project's Building Model (the architect's model, structure, existing MEP, our own Revit model): where each came from, the version shown and every version with its status (queued, converting, ready, failed), whether it is lined up (and what fixes it when not), its position adjustment in feet, the latest export from Revit and Docs files still coming in. Read this before levels from the architect, line-up or anything that depends on a linked model.

Input: project_id

bim_surfaces_at ​

Floor (or roof) under a placed part or a point, and the ceiling, roof and structure over it, each with its height and source (stated host, space ceiling height, our slabs, linked slabs/roofs/ceilings). Give element_id, or x_ft, y_ft and level.

Input: project_id, model_id, element_id?, x_ft?, y_ft?, level?

bim_describe_commands ​

The exact fields of a command family a MutinyBIM tool advertises in short form (bim_draw_detail items, bim_modify_detail operation, bim_set_system_design pipe_design and fittings, bim_route_run system_kind and from / to, bim_save_electrical_type entry, bim_preview_one_line / bim_layout_one_line diagram and hints). With only tool: its families; with field: its variants or schema; with variant: that one's schema. Reads no model; free.

Input: tool, field?, variant?

bim_preview_part_edit ​

Dry run: what one of the part edit tools would change at the revision you read (elements changed, removed, connections cut), or the reason it would be refused. Saves nothing and needs no approval.

Input: project_id, model_id, level?, zone?, tool, args

bim_preview_route_edit ​

Dry run of bim_route_run, bim_connect_runs, bim_disconnect_run, bim_route_flex, bim_resize_run, bim_slide_branch, bim_swap_fitting, bim_offset_run, bim_change_elevation, bim_set_fitting_coefficient_override, bim_set_system_design, bim_set_slope, bim_place_pipe_accessory, bim_split_run, bim_resize_stretch, bim_drag_run or bim_set_duct_insulation at the revision you read: the elements it would create or change, or the plain reason it would be refused. Saves nothing and needs no approval.

Input: project_id, model_id, level?, zone?, tool, args

bim_preview_views_sheets_edit ​

Preview one views/sheets command, or batch_documents { label, commands: [...] } (≤500, all or nothing, one approval), at the latest revision, unsaved: what would change or why it'd be refused, plus a preview_token. Save with bim_apply_views_sheets_edit: same command, base_revision = the returned revision, the token. Commands: create_view (schedules: props.schedule), create_3d_view, set_3d_view_camera, set_3d_crop_box, rename_view, duplicate_view, delete_view, set_view_properties (plans: props.circuitGraphics), set_view_crop, create_sheet, set_sheet_properties (incl. revisions), delete_sheet, place_viewport, move_viewport, resize_viewport, set_viewport_scale, set_viewport_north_arrow, remove_viewport, add/update/delete_drawing_item (shape callout: 3 points, callout.viewId), create/edit/resize/move/delete_text_note; live blocks: add_field_block { itemId, sheetId, at or at_in, block? } (no block: the load summary; block.table { kind: ventilation|pressurization|gas, scope? }: that table), edit_field_block; spaces: create_space, edit_space (estimateCounting max|actual_only|allocation_only|null), delete_spaces, make_spaces_from_rooms, place_space_in_walls { spaceId, levelId, seed } (a room from the walls around a point), split_space { spaceId, line, typedLoadsTo } (sub-rooms under the room; typedLoadsTo names the sub-room, e.g. 101A, that keeps loads not by area: required when it has any), merge_space_children { spaceId }, create/edit/delete_zone(s) (servedBy), place/calibrate/edit/delete_underlay(s); loads (any trade): create_load (anchor space/zone = estimate), move_load, split_load, edit_load_point (servedBy), set_load_allocation_policy; questions (no one has to answer; nothing is due): add_question { questions: [{ questionId, text, askOf, anchor: { elementIds }, type? assumption, blocksIssue?, askedBefore? }] }, answer_question { questionId, answer, status? assumed, outcome? judgment_recorded|design_revision, links? [{ kind: branch|determination, ref }] }, reply_question { questionId, text }, decline_question { questionId, note?, not_in_scope?, keep_closed? reason }, take_over_question { questionId }, forward_question { questionId, askOf }, set_question_status { questionIds, status withdrawn|open (declined: owner only) }, edit_question, delete_questions; stacks: name_stacks { stacks: [{ stackId, pipeId, number? }] }, edit_stack, delete_stacks, set_stack_checks { baseClearanceDiameters }. Kernel fields: mm (sheet positions, note sizes: paper). Standalone tools' names convert: crop_min_ft/crop_max_ft, far_clip_ft, cut_height_ft, top_ft, bottom_ft, view_depth_ft, center_in, size_in, level/scale atop create_view / set_view_properties. Unknown keys are refused by name.

Input: project_id, model_id, command

bim_apply_views_sheets_edit ​

Save exactly the change bim_preview_views_sheets_edit returned: the same command (one views/sheets command or a batch_documents of up to 500), its base_revision and its preview_token. Anything different is refused before it is sent, so what the person approves is what saves. Retrying the same call never saves it twice. If someone changed the same things since the preview, nothing is saved and you get a conflict: preview again.

Input: project_id, model_id, base_revision, preview_token, command

bim_render_view_image ​

Draw one view (floor or ceiling plan, section, 3D view, detail or drafting view, schedule) from the last saved revision as a PNG you can look at, exactly as it prints: linework, tags, dimensions, notes, crop. Use it after edits to check the drawing reads right (overlaps, clipped notes, missing tags). Optional: a region (view feet in the view's own frame, or paper inches from the drawing's top-left), elements to frame and outline in red, resolution. Returns the image, the revision drawn and the paper size.

Input: project_id, model_id, view, region_ft?, region_in?, focus_ids?, dpi?, max_px?, highlight_ids?, keep_copy?

bim_render_sheet_image ​

Draw one sheet from the last saved revision as a PNG you can look at, exactly as it prints: border, viewports at scale with titles, notes, schedules, title block. Use it to check a sheet's layout before printing or issuing. Optional: a region in paper inches from the sheet's top-left (to read small text), elements or drawn items to outline in red, resolution. A whole 36 x 24 sheet at the default size is an overview; zoom with region_in to read notes.

Input: project_id, model_id, sheet, region_in?, dpi?, max_px?, highlight_ids?, keep_copy?

bim_print_sheet_pdf ​

Draw one sheet from the last saved revision of the model to a vector PDF at true scale and return a download link valid for 5 minutes, with the revision printed and the file's sha256. It prints what is saved; edits still in flight are not included. print_notes: viewports past the drawing area, labels the PDF font printed as plain text (1⅜ as 1-3/8). Does not issue the sheet.

Input: project_id, model_id, sheet

bim_print_view_pdf ​

Draw one view (plan, section, 3D, detail or drafting view, schedule) on its own from the last saved revision to a vector PDF sized to the view at its scale, and return a download link valid for 5 minutes with the revision and sha256. For a sheet use bim_print_sheet_pdf; for several sheets in one PDF, bim_print_set_pdf. Does not issue anything.

Input: project_id, model_id, view

bim_print_set_pdf ​

Draw sheets from the last saved revision to one vector PDF (a page per sheet, true scale, binding order G, A, M, P, E… then number, or the order given); returns each sheet's page, the revision, sha256 and a 5-minute link. Records the print for bim_issue_set; print_notes as bim_print_sheet_pdf. Does not issue.

Input: project_id, model_id, sheets?, title?

bim_issue_set ​

Issue sheets: one edit adds add_revision to each sheet, the model is captured, the set drawn only from the capture, stored write-once and filed in the project Workspace. Nothing is issued if anything saved since expected_revision, the revision exists, or a sheet draws differently than in the last bim_print_set_pdf (live schedules; print and check again, or accept_changes_since_print once checked). Retry-safe.

Input: project_id, model_id, name, expected_revision, sheets?, add_revision?, accept_changes_since_print?

bim_place_part ​

Place any part (equipment, air terminal, receptacle, panel, light, plumbing fixture…) on a level at a plan position in feet. No location: the part is planned (exists for circuits, schedules and the one-line, waits in Not placed yet). part_id draws a planned part, or with unplace takes one off the drawing. A starter-library or firm-library type (from_firm_library) is added to the model with the part. Values are checked against the type's parameters; a bad value is refused with the reason.

Input: project_id, model_id, level?, zone?, base_revision?, type_id?, part_id?, unplace?, from_firm_library?, level_id?, x_ft?, y_ft?, level_hint?, space_hint?, note?, height_above_level_ft?, rotation_deg?, mark?, values?, mount?, on_plane_id?, intakes?, discipline?, equipment_list?

bim_move_elements ​

Move parts (and equipment with its connected ducts) by an offset in feet; parts can also move up or down. Tags follow.

Input: project_id, model_id, level?, zone?, base_revision?, element_ids, dx_ft, dy_ft, dz_ft?

bim_rotate_elements ​

Rotate parts about their insertion point (one part) or a pivot / their centre (several).

Input: project_id, model_id, level?, zone?, base_revision?, element_ids, angle_deg, about_x_ft?, about_y_ft?

bim_copy_elements ​

Copy parts by an offset in feet. Copies keep the type and values but start without a mark.

Input: project_id, model_id, level?, zone?, base_revision?, element_ids, dx_ft, dy_ft

bim_delete_elements ​

Delete parts, levels or other elements. If anything depends on them (tags, connections, parts on a level), the default refuses and lists them; choose disconnect or cascade to say what happens. The result says exactly what was removed.

Input: project_id, model_id, level?, zone?, base_revision?, element_ids, if_dependents?

bim_set_parameters ​

Set a part's own values (scope instance) or its type's values, shared by every part of that type (scope type). Values are validated; type values can't be set at instance scope.

Input: project_id, model_id, level?, zone?, base_revision?, element_id, scope, values?, mark?, mount?, intakes?

bim_move_wall ​

Move a wall by an offset in feet. The walls joined to it follow (their ends at its corners move with it, and walls teed into it stretch to stay on its face), so corners stay closed; its doors, windows, tags and room dimensions follow. disjoin: true leaves the joined walls where they are (Revit's Disjoin).

Input: project_id, model_id, level?, zone?, base_revision?, dx_ft, dy_ft, disjoin?, element_id?, wall_id?

bim_lint_configure ​

Once per session: how each saved edit's lint block checks (defaults: tolerance 0.5 in., clearances 1 in. services / 2 in. structure, radius 10 ft; snapshot after_edit adds a picture). Saved per thread (for=me: your model default). Returns settings and rules not available.

Input: project_id, model_id, ruleset?, tolerance_in?, soft_clearance_in?, structure_clearance_in?, scope_radius_ft?, include_linked?, max_findings?, snapshot?, disabled_rules?, for?, reset?

bim_lint_check ​

Every finding on the model, a level, or around ids, with the ruleset and tolerance used. Required (include_linked) before calling anything clash-free; ruleset issue before issuing. 25 a page.

Input: project_id, model_id, ids?, level?, ruleset?, include_linked?, include_accepted?, offset?

bim_status_snapshot ​

End of a batch: counts, findings by rule, this thread's last edits, up to 3 small pictures (last-edited plan, sheet, a 3D view, or those named). Say what you see.

Input: project_id, model_id, views?, sheets?, max_images?

Drafting and annotation ​

Family drafting: Dimensions, tags, notes with leaders, detail linework and detail components.

Turn it on: /packs/drafting/mcp, --packs drafting, or bim_enable_pack in a session.

bim_list_view_annotations ​

Every dimension, tag, note, line, rectangle and cloud in a plan, section, detail view or on a sheet: id, what it prints (dimension values, tag words, note text), points (view feet, or paper inches on a sheet), its paper box, the elements a dimension or tag follows and any it lost (orphaned), note leaders, and which annotations overlap. Use it before editing a detail or tidying a plan.

Input: project_id, model_id, owner

bim_add_dimension ​

Dimension in a plan, section or detail view. kind: linear (horizontal / vertical), aligned, angular (vertex, two points), radial / diameter (centre, a point on it), arc_length (centre, start, end), spot_elevation / spot_coordinate (the point, then the text). Two points, or more with chain continuous or baseline. A point follows an element (element_id + anchor; updates when the model moves) or is fixed in view feet. offset_in: the line's distance from the first point on paper (sign picks the side). Text override, prefix, suffix, style optional.

Input: project_id, model_id, base_revision?, view, kind, points, direction?, chain?, offset_in?, text_override?, prefix?, suffix?, style?

bim_auto_dimension ​

Deterministic dimensions for elements in a plan or section: mode each puts one aligned dimension along every run, wall or grid given (its start to end, offset beside it); mode chain puts one continuous string across them (horizontal or vertical) through each one's centreline, ordered along the string. All of it is one edit and every dimension follows its element.

Input: project_id, model_id, base_revision?, view, element_ids, mode, direction?, offset_in?

bim_add_tag ​

Tag one element in a plan or section. template auto picks by kind (duct or pipe size, terminal mark + CFM, equipment or fixture mark), or name one; fields lists parameters, one per line. The words always come from the element. at_ft places the head; absent, the first clear spot beside it. Returns looks: what it overlaps or crosses.

Input: project_id, model_id, base_revision?, view, element_id, template?, fields?, leader?, at_ft?, text_height_in?, style?

bim_preview_auto_tag ​

Tag all in a plan or section, previewed: everything of the categories, each tag at the first spot beside its element clear of linework and other annotations; existing tags stay. Returns what each will say, what couldn't be tagged and why, and a preview_token for bim_auto_tag_view.

Input: project_id, model_id, view, categories, leaders?, include_tagged?, text_height_in?, style?

bim_auto_tag_view ​

Apply the tags bim_preview_auto_tag returned (same arguments, its base_revision and preview_token) as one edit. Refused if the model changed since the preview: preview again.

Input: project_id, model_id, view, categories, leaders?, include_tagged?, text_height_in?, style?, base_revision, preview_token

bim_add_note ​

A rich text note (bold, italic, underline, lists, sizes; prints as shown) in a plan, section, detail view or on a sheet, with leaders to points, each with an optional elbow and an arrow, dot, tick or none. Points are view feet, or paper inches on a sheet (at_in). The box stays paper-sized at any scale.

Input: project_id, model_id, base_revision?, owner, text?, paragraphs?, at, width_in?, text_height_in?, leaders?

bim_edit_annotation ​

Change one annotation by id (from bim_list_view_annotations): move it by dx / dy (view feet, or paper inches on a sheet) or auto_place a tag clear beside its element; change a dimension's text override / prefix / suffix / offset / style or points (as in bim_add_dimension); a tag's template, fields, leader, elbow or style; a note's leaders; spread tags (item_id + item_ids) clear of each other; or delete it. Tag edits return looks (what it overlaps or crosses). One per call; for many, bim_apply_views_sheets_edit with a batch.

Input: project_id, model_id, base_revision?, owner, item_id, action, dx?, dy?, auto_place?, points?, offset_in?, text_override?, prefix?, suffix?, style?, template?, fields?, leader?, tag_style?, elbow?, item_ids?, leaders?

bim_set_tag_text ​

Replace the text of a model-linked tag.

Input: project_id, model_id, level?, zone?, base_revision?, text, element_id?, tag_id?

bim_list_tag_styles ​

The model's tag styles (lines with {field} placeholders, text height, leader, box, default_for kinds, tags using each) and the field names a style can use.

Input: project_id, model_id

bim_save_tag_style ​

A named tag look many tags share; changing it changes them all. style (id or name) changes or deletes one; without it, creates one named name, or from a preset (bim_list_tag_styles). lines: words and {field paths} per printed line, e.g. ["{size}[ {insulation}]"], ["{pipe.size}", "{pipe.length_lf}"]. box: true, false or a shape. orientation along: words follow the run. applies_to: kinds it labels; default_for: kinds whose new tags take it. "" clears prefix / suffix. delete: true removes an unused style.

Input: project_id, model_id, base_revision?, style?, name?, lines?, text_height_in?, leader?, box?, prefix?, suffix?, orientation?, units?, applies_to?, default_for?, preset?, delete?

bim_apply_tag_style ​

Put the tags in a plan or section (all, or only kinds / item_ids) on one tag style in one edit; their words, size, box and leader then follow it.

Input: project_id, model_id, base_revision?, view, style, kinds?, item_ids?

bim_list_detail_components ​

The 2D detail component library: id, name, category (duct, pipe, supports, valves, anchors, structure, insulation), default size in inches, and whether it stretches between two points (linear: flex duct, threaded rod). Use the id as symbol in bim_draw_detail.

Input: project_id, model_id

bim_draw_detail ​

Draw up to 500 items in a detail view, plan, section or sheet as one edit, on BIM conventions: detail lines are separate elements joined at their ends, so rect (four joined lines), polygon (inscribed or circumscribed), chain (lines through points, optionally closed; polyline is the same) make one line per side, ids <item id>-0, -1, …. Also line, arc (centre, start, end), arc_radius (start, end, radius, bulge side), arc_tangent (continues a line), circle, spline, region (hatch pattern, or masking; a closed sketch boundary), component (a library symbol at a point, rotated, mirrored, sized), repeat (a symbol repeated from one point to another), batt (insulation of a thickness between two points); on a sheet, figure (frame corner/opposite) with chart (plumbing.hunter_curve, live) or file_id + file_name (workspace PNG/JPEG). Each takes an optional line_style (the usual way to pick linework); weight (default medium) and pattern (default solid) override it; category is the view show / hide group; group makes a detail group (select, move, copy together). Fillets: bim_modify_detail. View feet for points, radii and distances, inches for sizes; on a sheet, paper inches. Points are {x, y}. Fields: line from, to; rect corner, opposite; circle center, radius; chain / polyline points, closed; arc center, start, end, clockwise; component symbol, at, width_in, height_in, rotation_deg, mirror; region points, hatch, masking; style keys line_style, weight, pattern, category, group. Every other shape's exact fields: bim_describe_commands({ tool: "bim_draw_detail", field: "items", variant: "<shape>" }). Dimensions: bim_add_dimension; notes: bim_add_note.

Input: project_id, model_id, base_revision?, owner, items, label?

bim_modify_detail ​

Change drafting items by id (from bim_list_view_annotations) with one operation, as one edit, on BIM drafting-view conventions. Detail lines joined end to end stay joined: moving, rotating, trimming or dragging an end stretches the joined line that wasn't picked (move disjoin: true leaves it). Operations: move / copy by dx, dy; rotate (about a centre, optionally a copy); scale; mirror about an axis (optionally a copy); array / polar_array (group: each copy its own detail group); align; offset lines, arcs and circles by a distance toward a side (pick a whole joined chain, e.g. a rectangle's four sides, and the corners still meet; copy: false moves them); trim_extend_corner (two items, a point on the part of each to keep); trim_extend_single (one item to a boundary, keep point); trim_extend_multiple (many items to one boundary, one keep point each); split (at a point; delete_to removes the piece between two points); split_gap; fillet_arc (two lines, radius; near1/near2 pick the parts to keep); chamfer; move_end (drag one end); pin / unpin (pinned items refuse to move, change shape or delete); delete; match_type (take source_id's line style and category). A rectangle drawn before joined lines existed becomes four joined lines on its first edit (ids <rect id>~s0..s3, in the same undo); naming it with two keep / near points picks the two sides at that corner. Items in a detail group bring the rest of their group (except the trims, splits, fillet, offset, move_end, match_type and delete, which act on exactly the items named). Dimensions that follow edited items update by themselves. Same units as bim_draw_detail (distance, radius and gap in view feet). Points are {x, y}. Fields: move / copy dx, dy (move disjoin); rotate center, angle_deg, copy; mirror axis_from, axis_to, copy; offset distance, toward, copy; trim_extend_corner keep1, keep2; trim_extend_single boundary_id, keep; split at, delete_to; fillet_arc radius, near1, near2; move_end end, to. Every other operation's exact fields: bim_describe_commands({ tool: "bim_modify_detail", field: "operation", variant: "<op>" }).

Input: project_id, model_id, base_revision?, owner, item_ids, operation

bim_copy_detail_items ​

Copy drawing items (by id, or every item when item_ids is absent) from one view or sheet into another (detail view, plan, section or sheet), shifted by dx / dy in the target's units. Dimensions among them that follow other copied items follow the copies; detail groups stay together. Use it to start a new detail from an existing one.

Input: project_id, model_id, base_revision?, from, to, item_ids?, dx?, dy?

bim_set_detail_group ​

Put drawing items in a detail group (they then select, move, copy and modify together), or take them out (group: null).

Input: project_id, model_id, base_revision?, owner, item_ids, group

Duct and pipe runs ​

Family ducts-pipes: Route, connect, resize, slope, insulate and fit duct and pipe runs.

Turn it on: /packs/ducts-pipes/mcp, --packs ducts-pipes, or bim_enable_pack in a session.

bim_route_run ​

Route a duct or pipe run through plan points (feet), from / to a part's connector, an open run end, or the side of a trunk (a new tap, tee or wye by the system's rules); from / to may be on another level, heights staying from level_id's floor. Drops, elbows, transitions and the branch fitting are created with it, all or nothing, and the connectors are linked. Duct legs run level at any plan angle (the Route tool snaps; give any angle), plumb, or at a 45° slope, each elbow made to its turn (up to 135°) with that angle's loss; elbow types made only for 45° / 90° (mitred with vanes) refuse other turns. Pipe legs run E-W, N-S or 45° and turn 45° or 90°. Rises, fitting choices, insulation, sizing from airflow and the person's saved defaults: see the fields.

Input: project_id, model_id, level?, zone?, base_revision?, level_id, kind, width_in?, height_in?, oval?, diameter_in?, nominal_in?, material?, spec?, elevation_ft?, points_ft, rise_style?, elbow_family?, takeoff_family?, from?, to?, system_id?, system_kind?, system_name?, cap_end?, slope_in_per_ft?, drain_flow?, insulation?, airflow_cfm?, duct_shape?, use_my_defaults?

bim_connect_runs ​

Connect existing duct or pipe, as one edit: two open ends that meet face to face (or an end to a part's connector, or two parts' connectors end to end); mode auto_route joins two open ends that don't meet with a square route (one rise or drop) worked out between them; tap_into_side continues an open end straight into another level run's side with a tap at that run's height (the Select tool's drag of an end onto a duct); tee_at_elbow turns a level elbow into a tee so a branch can continue from the corner (the + on an elbow). Run sizes and systems must match (two parts join anyway, mismatches reported); anything that can't be made is refused with the reason and nothing changes.

Input: project_id, model_id, level?, zone?, base_revision?, a_id, a_end, b_id?, b_end?, mode?

bim_disconnect_run ​

Cut one connection; both sides are left open. Nothing is deleted.

Input: project_id, model_id, level?, zone?, base_revision?, element_id, end

bim_route_flex ​

Flex from an open duct end into an air device's neck: round, sized to the neck, linked both ends. Refused if the end isn't the neck's size; warns past 6 ft.

Input: project_id, model_id, level?, zone?, base_revision?, from_run_id, from_end, to_part_id, to_connector?

bim_resize_run ​

Change a run's size: rectangular, round or flat oval duct, or pipe (nominal size + material). The connected segments and elbows of the same size follow; transitions and branch takeoffs on the edge take the new size; a size a connector or fitting cannot take is refused with the reason.

Input: project_id, model_id, level?, zone?, base_revision?, width_in?, height_in?, oval?, diameter_in?, nominal_in?, material?, spec?, element_id?, segment_id?

bim_slide_branch ​

Move a branch takeoff (a duct tap, or a routed tap, tee or wye on duct or pipe) to a new distance along its trunk. The trunk stays whole; connected pieces follow and parts stay put; if that is impossible you get the reason and nothing changes.

Input: project_id, model_id, level?, zone?, base_revision?, distance_ft, element_id?, tap_id?

bim_set_terminal_airflow ​

Set a diffuser or grille's design airflow (CFM). Totals up the system recompute.

Input: project_id, model_id, level?, zone?, base_revision?, cfm, element_id?, terminal_id?

bim_move_equipment ​

Move a unit by an offset in feet. Its connected ducts follow where they can.

Input: project_id, model_id, level?, zone?, base_revision?, dx_ft, dy_ft, element_id?, equipment_id?

bim_resize_riser ​

Resize a riser through every level it crosses, as one change.

Input: project_id, model_id, base_revision?, width_in?, height_in?, diameter_in?, element_id?, riser_id?

bim_list_fitting_types ​

The fitting library: every family routing can place, what it fits, and its parameters. Duct: elbows, transitions, offsets, takeoffs, caps. Pipe: domestic water, drainage / waste / vent and fuel gas fittings with their joints, materials, take-out, and for drainage which direction changes each may make (rules to check against the adopted code). Use the id with bim_swap_fitting, bim_set_system_design or bim_place_pipe_accessory.

Input: domain?, service?

bim_swap_fitting ​

Change a routed fitting to another library type (radius elbow r/W, mitred with turning vanes, 3/4/5-gore round, concentric / eccentric / rect-to-round transition, straight / 45° entry / conical / bellmouth / boot tap, lateral…). Same fitting, same connections. On the same type, params given change and the rest stay: an eccentric transition's flat side moves with params { flat: top | bottom | left | right } (Mirror = the opposite side) and keeps its wall angle. A type that can't be that fitting, or doesn't fit the duct beside it, is refused with the reason. Resizing a run to another shape swaps fittings not made in it (a smooth radius elbow on round duct becomes the system's round elbow) and says so.

Input: project_id, model_id, level?, zone?, base_revision?, family, params?, element_id?, fitting_id?

bim_offset_run ​

Jog a routed duct or pipe run left, right, up or down at a point, with two 45° elbows, two 90° elbows or one ogee offset. With length_ft the run comes back in line and both ends stay; without it everything beyond moves with it (connected parts that can't follow refuse).

Input: project_id, model_id, level?, zone?, base_revision?, at_ft, side, distance_in, length_ft?, style, element_id?, segment_id?

bim_change_elevation ​

Raise or drop a stretch of a level run to a new height with 45° or 90° rises, back to the old height at to_ft, or to the end of the run (what is connected follows).

Input: project_id, model_id, level?, zone?, base_revision?, from_ft, to_ft?, elevation_ft, style, element_id?, segment_id?

bim_split_run ​

Cut a routed duct or pipe segment in two at a point (a plain joint). Both pieces keep its size, system and connections; branches stay on the piece they sit on. A cut on a takeoff, or one leaving a piece too short for its fittings, is refused with the reason.

Input: project_id, model_id, level?, zone?, base_revision?, at_ft, element_id?, segment_id?

bim_resize_stretch ​

Give routed segments a new size or shape in one atomic edit (rectangular, round, flat oval, or pipe), optionally only between from_ft and to_ft on one segment. Elbows between resized pieces follow; where a neighbour keeps its size a transition is placed (the system's default, or concentric / eccentric flat top, bottom, left or right / rect-to-round), with the insulation of the duct it joins. Elbows, transitions and taps not made in the new shape take the system's choice for it (round duct gets the round elbow) and the result says which. Refused with the reason when a transition doesn't fit the straight duct beside it, or a branch would be as wide as its trunk.

Input: project_id, model_id, level?, zone?, base_revision?, segment_ids, from_ft?, to_ft?, width_in?, height_in?, oval?, diameter_in?, nominal_in?, material?, spec?, transition?

bim_drag_run ​

Move one straight routed segment or in-line elbow by east_ft / north_ft / up_ft, as dragging it in the view does; what it meets follows (legs along the move stretch, legs square to it move, fixed parts refuse). A segment moves square to itself or along itself; a 45° or sloped piece between legs at an angle slides so those legs only stretch. With end, only that end moves (raise the top of a rise to make it taller). As dragging does, a leg pulled back past its elbow turns the other way (its 90° elbows flip), and a move that can't go all the way (a leg shorter than its elbows need, an elbow that can't flip) stops at the limit; the result says how far it moved and why. strict: true never flips and stops at the elbow limit instead. Refused only when it can't move that way at all.

Input: project_id, model_id, level?, zone?, base_revision?, element_id, east_ft?, north_ft?, up_ft?, end?, strict?, stop_at_limit?

bim_set_system_design ​

Rename a system, or choose the fittings routing places on a system (per slot), and its design inputs: for duct, altitude, air temperature, duct material, the default insulation new runs get, and the sizing criteria bim_suggest_duct_size aims for; for pipe, pipe_design (water supply pressure, friction method, demand table, velocity limit; drain slopes, capacity table, direction-rule overrides; gas equation, specific gravity, allowable drop). No code tables are bundled: tables are the firm's own values.

Input: project_id, model_id, level?, zone?, base_revision?, system_id, name?, altitude_ft?, temperature_f?, material?, fittings?, default_insulation?, sizing?, pipe_design?

bim_set_duct_insulation ​

Put an external wrap or internal liner (thickness in inches, optional material and R-value) on routed duct, or a wrap on pipe, or take it off: one piece, the run (stopping at transitions, branches and parts), or every duct or pipe of the system; from_schedule gives a pipe system the project's thickness by size. The size stays the sheet-metal size; a liner narrows the airway the pressure report uses (faced liner by default; surface spray_coated is rougher), a wrap grows the outside size. Fittings take the insulation of the duct they join. A liner that leaves less than 2" clear inside is refused with the reason.

Input: project_id, model_id, level?, zone?, base_revision?, element_id, insulation?, scope?, from_schedule?

bim_set_slope ​

Pitch one level pipe segment (a drain) to a fall in inches per foot: one end stays, the other rises or drops, and what is connected beyond it follows (level runs move, vertical runs stretch, fixed fixtures refuse). Flatter than the system's minimum, or sloping a branch away from the run it drains into, is refused with the reason.

Input: project_id, model_id, level?, zone?, base_revision?, in_per_ft?, flow?, keep?, element_id?, segment_id?

bim_place_pipe_accessory ​

Place a valve, union, coupling, cleanout, test tee, P-trap, gas cock, drip leg or gas regulator (params role, outlet_in_wc, zone_drop_in_wc: starts a pressure zone) inline on a pipe segment, at a distance from its start. Checked for service, material, joint, pipe direction and room.

Input: project_id, model_id, level?, zone?, base_revision?, at_ft, family, params?, element_id?, segment_id?

Electrical circuits and diagrams ​

Family electrical: Panels, circuits, feeders, receptacle proposals, one-line and riser diagrams.

Turn it on: /packs/electrical/mcp, --packs electrical, or bim_enable_pack in a session.

bim_electrical_report ​

Every panel, switchboard and transformer (or one, by id or name) with what it supplies and is fed from: connected load, NEC Article 220 demand by load class from the raw loads below it (220.56 kitchen equipment counted at each panel, so the MDP and the serving panel differ), the sizing load with continuous loads at 125% and the largest motor +25%, per-phase VA and amps, the true capacity with its limiting reason (bus, main, transformer kVA, feeding breaker, feeder conductors, what is left upstream), and findings (overloaded, unbalanced phases, a member whose voltage no longer matches, a bus bigger than its breaker, a load with nothing to count). One panel also lists its circuits and their members. The NEC edition is nec_edition, else the project's Code Study, else the state; with none of those the totals are connected loads only and say so. Read-only; no approval.

Input: project_id, model_id, panel?, include_circuits?, nec_edition?, state?, occupancy?

bim_read_panel ​

One panel as the Building Model's panel view draws it: every used slot with its circuit, breaker, poles and members, the free slots, and what feeds it. No panel: the devices on no circuit yet. Totals and capacity are in bim_electrical_report. Read-only.

Input: project_id, model_id, panel?

bim_electrical_catalog ​

The project's connection types (designator → load, voltage, poles, class), feeder types (mark → breaker, conductor sets, ground, conduit) and room templates. size_feeder_for: propose a feeder type for that panel from its NEC calculated load (breaker, conductors with voltage drop, parallel sets, EGC, conduit, with clauses) to save with bim_save_electrical_type. check: the Electrical tab's check list (overloads, unbalance, voltage mismatch, breakers vs nameplate, loads on no circuit). Read-only.

Input: project_id, model_id, kind?, size_feeder_for?, length_ft?, material?, conduit?, check?, nec_edition?

Read the circuit numbers people typed on devices ("L1-3", "HP1-43,45") and the "Fed from" typed on panels ("MDP"), and return, for each circuit or feeder, what would be made, whether the model allows it (with the reason when not), and the exact arguments for bim_create_circuit or bim_add_to_circuit. Devices are grouped only when their own text names the same panel and circuit numbers. Nothing is changed: show the person the proposals and make only the ones they confirm, one approval each. Read-only; no approval.

Input: project_id, model_id

bim_preview_circuit_edit ​

Dry run of a circuit, rebalance, catalog or room-template edit tool at the revision you read: what it changes (a rebalance's moves, a template's circuits per unit), or the plain reason it would be refused. Saves nothing; no approval.

Input: project_id, model_id, tool, args

bim_create_circuit ​

Serve the listed devices or equipment from a panel's breaker (a branch circuit), or another panel or transformer from a breaker in this one (a feeder; a transformer's secondary feeds its panel with no breaker). Members are exactly what the person asked for. Positions are the panel's circuit numbers (one per pole: 1,3,5 for three poles); leave them out to take the lowest free ones that fit. The breaker defaults to one piece of equipment's MOCP, else 20 A; a feeder's to the fed panel's main, else its bus. Refused in plain words when voltage, poles, phases or free positions don't allow it (e.g. a 480 V unit on a 120/208 V panel): say the reason as written. A retried identical call is refused as already made. Pauses for the person's approval.

Input: project_id, model_id, base_revision?, source_id, members, positions?, description?, breaker_a?, frame_a?, load_class?, conductors?, length_ft?, feeder_type?, circuit_id?, one_circuit_each?

bim_edit_circuit ​

Move a circuit or feeder to other positions or another panel (its members are checked again), or change its breaker, frame, load class, conductors, length, feeder type or description. null clears a value. Members don't change here (bim_add_to_circuit, bim_remove_from_circuit). An existing circuit on a renovation (built in the Existing phase: bim_set_element_phases on its id) keeps its panel and slots. Refused in plain words when the move isn't allowed. Pauses for the person's approval.

Input: project_id, model_id, base_revision?, circuit_id, source_id?, positions?, description?, breaker_a?, frame_a?, load_class?, conductors?, length_ft?, feeder_type?

bim_add_to_circuit ​

Put the listed devices or equipment on an existing circuit (exactly those). Each is checked against the panel's voltage and the circuit's poles; refused in plain words otherwise, and a device already on a circuit is refused. Pauses for the person's approval.

Input: project_id, model_id, base_revision?, circuit_id, members

bim_remove_from_circuit ​

Take the listed devices or equipment off a circuit. The circuit stays, even empty (a spare); delete it with bim_delete_elements. Pauses for the person's approval.

Input: project_id, model_id, base_revision?, circuit_id, element_ids

bim_feed_panel ​

Feed a panel or transformer from a breaker in another board or panel, or from a transformer's secondary; a feeder it already has moves instead of a second one being made. Refused in plain words on a mismatch (a 120/208 V panel off a 480 V board needs a transformer between; never add one yourself, ask). Pauses for the person's approval.

Input: project_id, model_id, base_revision?, panel_id, source_id, positions?, breaker_a?, feeder_type?

bim_rebalance_panel ​

Move or swap circuits on one panel so its phases carry more even load (deterministic: the same model gives the same moves; three-pole breakers and keep_circuits stay; what is on each circuit never changes). Preview the moves with bim_preview_circuit_edit first and show them. Pauses for approval.

Input: project_id, model_id, base_revision?, panel, keep_circuits?, max_moves?

bim_save_electrical_type ​

Add or change one catalog record; replaces renames it and what names it follows (devices' connection_type, feeders' feeder type). delete removes one nothing uses. Devices take a connection type through bim_set_parameters values.connection_type. Pauses for approval.

Input: project_id, model_id, base_revision?, entry?, replaces?, delete?

bim_apply_circuit_template ​

Circuit the devices in each unit's rooms by the firm's room template (bedroom → 1…). The person names each unit's rooms and panel; never choose a panel or rooms yourself. Devices already on a circuit are left alone; a refused circuit is reported, the rest are made. Preview with bim_preview_circuit_edit. Pauses for approval.

Input: project_id, model_id, base_revision?, template, units

bim_preview_one_line ​

Preview a diagram without saving: what it draws, warnings (bus vs feeding breaker), size, and would_save with a preview_token for bim_layout_one_line. from_model: true (the normal case) makes a LIVE diagram drawn from the model at every revision: kind one_line, electrical_riser, plumbing_riser (branches, sizes, running DFU/WFU/MBH; pipes listed) or plumbing_isometric, with layout hints; with view, an existing drafting view becomes live or gets new hints. diagram (static) is only for a distribution described by hand with no model: roots are utility/generator sources; children CT cabinet, meter, switchboard / panelboard / MCC with a main, transformer, ATS with its emergency generator, disconnects, VFD, UPS, motors; each with name, ratings and its feeder (device, label, sets, conductors, conduit, length). Free; no approval.

Input: project_id, model_id, view?, replace_existing?, new_view_name?, diagram?, from_model?, kind?, hints?, place_on?

bim_layout_one_line ​

Save what bim_preview_one_line previewed, as one change: a live diagram view (or its new hints), or the static drawing, and (place_on) its viewport on a sheet. Same arguments plus the preview's base_revision and preview_token; anything different is refused. A live diagram redraws itself when the model changes; change its layout by calling again with view and hints. Look at it after with bim_render_view_image.

Input: project_id, model_id, view?, replace_existing?, new_view_name?, diagram?, from_model?, kind?, hints?, place_on?, base_revision, preview_token

bim_propose_receptacles ​

Where receptacles of the chosen type would go in the picked rooms: 210.52 wall space, countertops, islands, bathrooms, laundry, hallways (needs the NEC edition), or a density preset (firm spacing, no code edition; code says so). Wall devices sit with their back on the wall face. Each device has a key, reason and clause; coverage says if every point is in reach. Read-only; accept with bim_accept_receptacles.

Input: project_id, model_id, rooms, mode?, preset?, wall_type, countertop_type?, bathroom_type?, room_rules?, nec_edition?, apply_to_similar?

bim_accept_receptacles ​

Re-runs the proposal at the revision you read and places the kept devices as one edit, uncircuited. Send the proposal's arguments. Pauses for approval.

Input: project_id, model_id, base_revision?, rooms, mode?, preset?, wall_type, countertop_type?, bathroom_type?, room_rules?, nec_edition?, apply_to_similar?, keep?

bim_place_service_layout ​

From a service size (yours or bim_service_from_equipment_list's): meter, optional main disconnect, MDP and the listed panels and transformers, each fed from what's named, as one edit. Ask for every rating; nothing is sized. Pauses for approval.

Input: project_id, model_id, base_revision?, level, origin_ft?, room?, service_a, system, meter?, main_disconnect?, plan_only?, distribution?, equipment?

Plumbing loads and design ​

Family plumbing: Fixture load points, connection types, pipe types and each pipe system's sizing.

Turn it on: /packs/plumbing/mcp, --packs plumbing, or bim_enable_pack in a session.

bim_place_load_points ​

Put loads on open pipe ends or taps without fixtures (one batch, up to 500). Each names a connection type (WSFU/DFU/MBH/CFM come from it) or gives values; one point per end, per system (a sink: cold, hot and waste points sharing a mark). A type with no connection of the pipe's system is refused; points returns each point's pipe, system and loads, with warnings. Then read totals with bim_pipe_report. Pauses for approval.

Input: project_id, model_id, base_revision?, points

bim_edit_load_point ​

Any trade's loads. edit: type, values or source (served_by; part_id edits every point of an attached fixture). attach: the fixture the person named takes the point's connection type; totals unchanged. detach keeps the point. split: break a lump onto new points, totals preserved. delete. create: loads on a space/zone (an estimate), a part, a point or nowhere yet. move: same id to a new anchor (estimate → point → device). policy: how estimates count once devices exist. Pauses for approval.

Input: project_id, model_id, base_revision?, action, load_point_id?, part_id?, connection_type?, values?, reset?, mark?, into?, load_point_ids?, served_by?, clear_served_by?, loads?, to?, policy?

bim_save_connection_type ​

Add or change a connection type: trade plumbing/gas/mechanical/electrical, quantities (wsfu_cold, wsfu_hot, wsfu_total = the code's combined value, dfu, gph_demand, mbh, min_inlet_pressure in psi, cfm, sizes, custom; text with a unit like '7 in. w.c.' is converted). replaces renames it; delete removes one nothing uses. Pauses for approval.

Input: project_id, model_id, base_revision?, entry?, replaces?, delete?

bim_plumbing_catalog ​

Pipe types (material, spec, sizes, joint, systems, the fittings each slot takes: the material's unless picked), every pipe system's colour, line pattern, weight and own sizing, the project's auto-sizing, building type, demand curve and pipe insulation schedule, and the stacks (named or not: tag, size and DFU per floor, offsets). Read-only.

Input: project_id, model_id

bim_plumbing_design ​

One change. system_look: colour/pattern/weight (null: standard). system_sizing / project: sizing_mode, demand_curve (project also building_type, insulation_schedule). save_pipe_type / delete_pipe_type. Turn auto-sizing on only when the person asks: on, edits resize that system's pipes as they land. Pauses for approval.

Input: project_id, model_id, base_revision?, action, system?, colour?, pattern?, weight?, sizing_mode?, demand_curve?, building_type?, insulation_schedule?, insulation_source?, pipe_type?, replaces?, name?

Views and sheets ​

Family views-sheets: Views, crops, 3D views, sheets, viewports, sheet notes and layout.

Turn it on: /packs/views-sheets/mcp, --packs views-sheets, or bim_enable_pack in a session.

bim_create_view ​

Create a floor plan or ceiling plan for a level, a section from a cut line (plan feet) with a look direction and depth, a 3D view, or a detail view (drawing-only: lines, text, dimensions). Returns the new view id. Refused with a plain reason if the name is taken or a plan has no level.

Input: project_id, model_id, base_revision?, name, view_type, level?, scale?, cut_height_ft?, section_start_ft?, section_end_ft?, section_looks?, section_depth_ft?

bim_set_view_properties ​

Set a view's scale, what a plan shows (top_ft, cut_height_ft, bottom_ft, view_depth_ft: our model and the linked models both follow them), line weights by category (line_weights; linked models take cut_line_weight / beyond_line_weight), linked-model simplification (linked_hidden_lines removes a chair under a table; linked_min_object_in leaves out small things), plan orientation (plan north, true north or the working angle up), discipline (others print halftone; null for all in ink), hidden categories, how each linked model draws (normal, halftone, transparent, underlay or hidden, a 3D see-through %, per-IFC-category exceptions; a person's working 3D view '{3D - name}' takes these too), detail level, or its crop box. The crop box is in feet in the view's own frame: plan x/y for plans and 3D views, along-the-cut distance by elevation for sections, drawing feet for detail views. crop_view off shows everything; show_crop_box only changes what editors see (the boundary never prints); annotation_crop lets notes and tags reach past the crop; far_clip_ft sets how far a section sees; fit_crop sizes the crop to the view's content (send it on its own). A placed view's viewport resizes with its crop. Give the view by id or exact name.

Input: project_id, model_id, base_revision?, view, scale?, cut_height_ft?, discipline?, hidden_categories?, hidden_drafting_categories?, linked_models?, detail_level?, crop_min_ft?, crop_max_ft?, fit_crop?, keep_viewport_center?, crop_view?, show_crop_box?, annotation_crop?, annotation_crop_offset_in?, far_clip_ft?, orientation?, projection?, top_ft?, bottom_ft?, view_depth_ft?, line_weights?, linked_hidden_lines?, linked_min_object_in?, category_overrides?

bim_rename_view ​

Rename a view. Refused if another view has that name. Its sheet titles follow.

Input: project_id, model_id, base_revision?, view, name

bim_duplicate_view ​

Copy a view with its properties and crop (and a detail view's drawing) under a new name (default "<name> Copy"). The copy isn't on a sheet. Use it to show the same plan twice, e.g. an enlarged plan.

Input: project_id, model_id, base_revision?, view, name?

bim_delete_view ​

Delete a view. A view placed on a sheet is refused unless if_placed is remove_from_sheet (its viewport goes too). Undo brings it back.

Input: project_id, model_id, base_revision?, view, if_placed?

bim_create_sheet ​

Create a sheet with a number, name, title block (ARCH D 36x24 by default, or ANSI B 17x11) and title block fields (client, address, drawn_by, checked_by, date, status). Refused if the number is taken.

Input: project_id, model_id, base_revision?, number, name, title_block?, fields?

bim_set_sheet_properties ​

Change a sheet's number, name, title block size, title block fields (client, address, drawn_by, checked_by, date, status, or any other key; an empty string clears one), and its revision table: add_revision appends one row; revisions replaces the whole table (oldest first). Refused if the number is taken, a revision number repeats, or a smaller title block can't hold its viewports.

Input: project_id, model_id, base_revision?, sheet, number?, name?, title_block?, fields?, add_revision?, revisions?

bim_delete_sheet ​

Delete a sheet with its viewports, notes and linework. Its views are kept (no longer placed). Undo brings it back.

Input: project_id, model_id, base_revision?, sheet

bim_place_viewport ​

Place a view on a sheet as a viewport, centred at a paper position in inches from the sheet's top-left, at the view's scale or the one given. A view goes on one sheet only; the refusal names the sheet it is already on.

Input: project_id, model_id, base_revision?, sheet, view, center_in, scale?

bim_edit_viewport ​

Change a placed view on its sheet. action move: centre_in on paper (inches from the sheet's top-left). resize: the frame's size_in (the view's crop box follows at the viewport's scale; optional centre_in). scale: a new drawing scale (the frame grows or shrinks; the crop box stays). A live diagram or schedule is its own size: move only. A frame past the drawing area saves with a warning. north_arrow: show or hide. remove: take it off the sheet (the view is kept). Name the viewport by its view's name or id (optionally the sheet), or the viewport id. To place many at once, use bim_auto_layout_sheet.

Input: project_id, model_id, base_revision?, viewport, sheet?, action, center_in?, size_in?, scale?, show?

bim_preview_sheet_layout ​

Work out where every viewport on a sheet should go, without saving: frames packed in rows (or an aligned grid) inside the border and left of the title block, with room under each for its title; optionally shrinking a view's scale to fit. Same model, same answer every time. Returns the moves, any view that can't fit (and why), and a preview_token for bim_auto_layout_sheet.

Input: project_id, model_id, sheet, mode?, columns?, gap_in?, fit_scales?, smallest_scale?, order?

bim_auto_layout_sheet ​

Apply the layout bim_preview_sheet_layout returned, as one edit: same arguments, its base_revision and preview_token. Refused if the model changed since the preview (the layout would differ): preview again.

Input: project_id, model_id, sheet, mode?, columns?, gap_in?, fit_scales?, smallest_scale?, order?, base_revision, preview_token

bim_set_issue_status ​

Read only, issues nothing: whether every sheet draws as in the last set print (and which differ or weren't printed), the revision to pass bim_issue_set as expected_revision, the next revision number, the last print, earlier issues (newest first, with 5-minute PDF links), and each live block: Live, Matches or Changed since its last issue.

Input: project_id, model_id, sheets?

bim_add_sheet_note ​

Write a note on a sheet: a box at a paper position (inches from the top-left) that wraps its text at width_in. Plain text, or rich paragraphs with bold, italic, underline, bullets, numbered lists (with levels), alignment and per-run text height. It prints exactly as people see it. Use bim_preview_views_sheets_edit with create_text_note to check it first. Characters outside letters, numbers and drafting symbols are refused with the reason.

Input: project_id, model_id, base_revision?, sheet, text?, paragraphs?, at_in, width_in?, height_in?, rotation_deg?, leader_to_in?, text_height_in?

bim_edit_text_note ​

Replace a note's whole text (on a sheet or in a detail view) with plain text or rich paragraphs, keeping its box and position. Pass expected_content from bim_list_views_and_sheets: if anyone changed the note's words since you read it, nothing is saved and the result says so. Read again and re-plan.

Input: project_id, model_id, base_revision?, note, expected_content, text?, paragraphs?

bim_create_3d_view ​

Create a saved 3D view, pre-cropped: of_elements (or region_ft) fits its 3D crop box to them, grown out to the floor and next level and the grid lines around them (a storey and bay, never a tight box); box_ft sets the box exactly; neither crops to the whole model. look_from picks the camera (default south_west isometric). place_on puts it on a sheet in the same approval, e.g. an isometric of a mechanical room. On sheets it prints as vector hidden-line from its camera, cropped to the whole box. Returns the new view id.

Input: project_id, model_id, base_revision?, name, of_elements?, region_ft?, box_ft?, look_from?, projection?, place_on?

bim_set_3d_view_camera ​

Point a saved 3D view's camera: look_from a named direction at its crop box, or eye_ft and target_ft exactly (feet). Optionally switch projection. The view opens from here and prints from here; a placed viewport's frame resizes to the box as seen from the new camera.

Input: project_id, model_id, base_revision?, view, look_from?, eye_ft?, target_ft?, projection?

bim_set_3d_crop_box ​

Size, fit, or switch a saved 3D view's 3D crop box: box_ft sets it exactly; fit 'selection' with element_ids (or region_ft) grows it to the storey and grid bay around them; fit 'model' puts it back around the whole model (square to the working angle). align 'working_angle' turns the box about its middle to the view's working angle, or align with from_ft/to_ft turns it square to a building edge; its size is kept (there is no rotate handle on the box; this is how it turns). crop_on false shows everything (the box is kept); show_box only changes what people editing see (it never prints). It crops live and on sheets, heights included; a placed viewport's frame follows.

Input: project_id, model_id, base_revision?, view, box_ft?, fit?, element_ids?, region_ft?, crop_on?, show_box?, align?

Coordination and linked models ​

Family coordination: Linked models, levels from them, coordinates, accepted findings and rooms.

Turn it on: /packs/coordination/mcp, --packs coordination, or bim_enable_pack in a session.

bim_browse_autodesk_docs ​

List a folder of the project's Autodesk Docs project (top folders when folder_id is left out), or search below it by name. Each file says whether it can be linked and why not, and which linked model it already is. Needs model edit access and the person's Autodesk sign-in (Settings), like Link a model › From Autodesk Docs. Then bim_link_from_autodesk_docs.

Input: project_id, folder_id?, query?

Bring up to 25 Revit or IFC files from the project's Autodesk Docs into the Building Model as linked models, each with the name people see and its discipline. A file already linked adds a new version to that linked model. Autodesk exports and converts them in the background; bim_list_linked_models shows progress. Needs model edit access and the person's Autodesk sign-in.

Input: project_id, items

bim_update_linked_model ​

The Linked models panel's actions on one linked model: check Docs for a newer version or export it again, line it up with the project model, export our own Revit model again, try a failed conversion again, show another converted version, or save a position adjustment (feet and degrees from where it was placed; give only what changes). What changes is seen by everyone on the project. Read bim_list_linked_models first.

Input: project_id, action, reference_id?, version_id?, east_ft?, north_ft?, up_ft?, rotation_deg?

Take a linked model out of the Building Model for everyone on the project. Its files and versions are kept, and a conversion still running won't bring it back; linking it again from Docs or an upload adds it anew. Views that showed it stop drawing it.

Input: project_id, reference_id

bim_sync_linked_levels ​

Make the model's levels match a linked model's storeys in one undoable change: a level for each storey not yet made, and the levels made from storeys updated where the architect moved or renamed them. A level a person already made for the same floor (same name or elevation) is tied to the storey and keeps its name. Nothing is deleted; running it again when nothing changed is refused with that reason. Defaults to the architectural model.

Input: project_id, model_id, base_revision?, linked_model_id?

bim_update_level ​

Move a level to a new floor elevation (feet) and/or rename it. Everything on the level moves with it (parts and runs keep their height above it); plans, schedules and elements that name the level follow a rename. Refused if another level has the name.

Input: project_id, model_id, base_revision?, level_id, name?, elevation_ft?

bim_create_level ​

Add a level (storey) with a name and floor elevation in feet. Parts are placed on levels.

Input: project_id, model_id, level?, zone?, base_revision?, name, elevation_ft

bim_read_coordinates ​

Where the model sits: the project base point and survey point (model feet and site N/S, E/W, elevation in feet), the internal origin, true north (degrees clockwise from plan north), the working angle (the model's and any view's own) and the placement an IFC export carries. Read before changing coordinates.

Input: project_id, model_id

bim_preview_coordinates_edit ​

Dry run of bim_set_project_origin, bim_set_survey_point, bim_set_true_north or bim_set_working_angle at the latest revision: what would change, or the reason it would be refused. Saves nothing and needs no approval.

Input: project_id, model_id, tool, args

bim_set_project_origin ​

Either move only the base point on the model (move_point: everything keeps its site coordinates) or relocate the project on the site (relocate_project: geometry stays put, every element's site coordinates change by the same move, the survey point stays on the site). Feet.

Input: project_id, model_id, base_revision?, mode, position?, shared?

bim_set_survey_point ​

The same two moves as the Coordinates dialog's survey point: move only its marker on the model (move_point: nobody's site coordinates change), or give it the site coordinates it should read (relocate_project: the site moves under the building, every element's site coordinates change, geometry and linked models stay put). Feet. Read bim_read_coordinates first.

Input: project_id, model_id, base_revision?, mode, position?, shared?

bim_set_true_north ​

Set the angle from plan north to true north (degrees clockwise), or give two plan points along true north. Turns the building on the site about the project base point; geometry and plans drawn plan-north do not move.

Input: project_id, model_id, base_revision?, angle_deg?, from_ft?, to_ft?

bim_set_working_angle ​

Turn the directions people draw in to match a skewed building: give angle_deg, or two plan points along a building edge (from_ft, to_ft) and the axes turn square to it. Route snaps (square and 45°), the placement grid, drafting ortho/polar and new 3D crop boxes follow it; plans set to orientation 'working_angle' draw turned to it. With view, it applies to that view only (use_model_angle drops the view's own). Never moves geometry, linked models, site coordinates or true north.

Input: project_id, model_id, base_revision?, angle_deg?, from_ft?, to_ft?, view?, use_model_angle?

bim_lint_accept_finding ​

Accept a finding with the person's reason (hidden for everyone until its elements change). Only when the person says so. finding_id must be an id from bim_lint_check now; any other id is refused.

Input: project_id, model_id, finding_id, reason, check_only?

bim_lint_retract_acceptance ​

Undo an acceptance (one made by mistake, or no longer true) with the person's reason: the finding shows again; who accepted, who retracted and why are kept. Only when the person says so.

Input: project_id, model_id, finding_id, reason, check_only?

bim_trace_rooms ​

Adds rooms (outline in feet) with a wall on each edge, doors, windows and counters or fixtures, as one edit, so proposers can measure them. Trace only what the plan shows. Pauses for approval.

Input: project_id, model_id, base_revision?, level, rooms, openings?, casework?, wall_thickness_in?

Groups, phases and typed elements ​

Family groups-phases: Groups, locks, phases, phase filters and typed element values.

Turn it on: /packs/groups-phases/mcp, --packs groups-phases, or bim_enable_pack in a session.

bim_list_groups_and_phases ​

The model's groups (name, colour, locked, default visibility), phases in time order, phase filters (how new / existing / demolished / temporary elements draw), the active group and phase new work goes in, and each view's phase, filter and group visibility. include_counts adds elements per group (reads the whole model; skip on very large models unless needed). Every element is in one group; elements with no group are in General, with no phase are built in New construction.

Input: project_id, model_id, include_counts?

bim_preview_organization_edit ​

Run one groups/phases command against the latest revision without saving: what would change, or the plain reason it would be refused (a locked group, a phase in use, demolished before built). Commands: create_group, update_group, lock_group, delete_group (moveTo), set_active_group, assign_elements_to_group, create_phase, update_phase (after), delete_phase, set_active_phase, set_element_phases, demolish_elements, undemolish_elements, create_phase_filter, update_phase_filter, delete_phase_filter, set_group_typical (repeat a unit: array { count, columns, spacingMm } or copies; its loads count once per copy where it is served from outside), clear_group_typical. Ids, not names.

Input: project_id, model_id, command

bim_create_group ​

Add a group (e.g. 'Phase 2 tenant fit-out'). New work goes in it only once it is made active. Refused if the name is taken.

Input: project_id, model_id, base_revision?, name, color?, description?, default_visibility?

bim_update_group ​

Rename a group, change its colour, description or default visibility, or lock / unlock it. Locked: nobody (people or agents) can create, change, move, demolish or delete its elements until it is unlocked. typical repeats the group (unit 001 x24: copies draw on plans and count in every trade's totals: drain, service, meter, project); typical null stops. Send locked or typical on its own call.

Input: project_id, model_id, base_revision?, group, name?, color?, description?, default_visibility?, locked?, typical?

bim_delete_group ​

Delete a group. If elements are in it, give move_to (the group they go to); without it a group with elements is refused. General can't be deleted. Undo brings the group back.

Input: project_id, model_id, base_revision?, group, move_to?

bim_assign_to_group ​

Move elements (a run, a branch, a box selection's ids) into a group. Refused, with nothing changed, if any of them, or the target, is in a locked group.

Input: project_id, model_id, base_revision?, element_ids, group

bim_set_active_group_and_phase ​

Set the model's active group (new ducts, pipes and parts go in it) or active phase (new elements are built in it; demolish uses it), typical_cap, switch an add-on on or off for this model (addon), or branch: start one (Main is untouched) or propose this thread's branch to Main; people approve merges. Give one of them per call. A locked group can't be made active.

Input: project_id, model_id, base_revision?, group?, phase?, typical_cap?, addon?, branch?

bim_create_phase ​

Add a phase in time order: after a named phase, first (after: null), or last (after absent).

Input: project_id, model_id, base_revision?, name, after?

bim_update_phase ​

Rename a phase, or move it in time (after: a phase, or null for first). Moving is refused if something would be demolished before it is built.

Input: project_id, model_id, base_revision?, phase, name?, after?

bim_set_element_phases ​

Set the phase elements are built in and/or demolished in (demolished_in: null = not demolished), or action 'demolish' (in the given phase, default the active phase) / 'restore' (not demolished). Refused if something would be demolished before it is built, or is in a locked group.

Input: project_id, model_id, base_revision?, element_ids, action?, built_in?, demolished_in?, phase?

bim_set_view_organization ​

Set which phase a view shows the model as of, its phase filter, and per group show / halftone / hide in that view (only the groups given change). This reaches the live canvas, the printed drawing, sheets and PDF.

Input: project_id, model_id, base_revision?, view, phase?, phase_filter?, groups?

bim_set_phase_filter ​

Create a phase filter (give name and all four statuses) or change one (give filter and any of name / statuses). Each status draws as show, halftone, dashed or hide. new = built in the view's phase; existing = built earlier and still there; demolished = removed in the view's phase; temporary = built and removed in it.

Input: project_id, model_id, base_revision?, filter?, name?, new?, existing?, demolished?, temporary?

bim_delete_phase ​

Delete a phase nothing uses. Refused, with the reason, if any element is built or demolished in it, a view shows it, it is the default phase, or it is the last one. Undo brings it back.

Input: project_id, model_id, base_revision?, phase

bim_delete_phase_filter ​

Delete a phase filter no view uses. Refused, with the views that use it, otherwise; the last filter can't be deleted. Undo brings it back.

Input: project_id, model_id, base_revision?, filter

bim_set_element ​

One change per call on walls, slabs, openings, rooms, grids, columns, beams and components: class, type_id, values (by parameter key; a part takes its add-on keys here), place (geometry in plan feet), lock (existing or issued, with a reason; false unlocks), new_type (a shared type to set with type_id) or code. Preview with bim_preview_part_edit.

Input: project_id, model_id, level?, zone?, base_revision?, element_ids?, class?, type_id?, values?, place?, lock?, new_type?, code?, architecture?

Part definitions ​

Family parts: Draft, check and save parts, the firm's part library, clearances and hosts.

Turn it on: /packs/parts/mcp, --packs parts, or bim_enable_pack in a session.

bim_draft_part_from_cut_sheet ​

Draft a part (rooftop unit, air terminal, water heater) from a cut sheet PDF on the project. Returns the sheet text by page, each fact (dimensions, openings, connections, electrical, capacity, model) cited to page and line, assumptions, and a checked part definition. Saves nothing. Fix what's wrong (bim_check_part_definition), then save with bim_save_part_definition or bim_save_firm_part (both pause for approval).

Input: project_id, file_id?, file_url?, kind?, part_name?

bim_read_picture_rows ​

Equipment schedule (picture or PDF on the project) to planned rows. First call saves nothing: rows (page, values, check_this) and next steps. Commit: rows, type_id, file_name, base_revision, preview_token, user_confirmed (pauses for approval).

Input: project_id, model_id, base_revision?, file_id, hint?, type_id?, file_name?, rows?, preview_token?, user_confirmed?

bim_part_definition_example ​

A complete, valid part definition to start from (rooftop_unit: box on a hollow curb with a cut-in panel, two duct and one power connector, three sizes; floor_drain: revolved body and outlet with a strainer symbol), plus a short guide to every field. Use it as the template for bim_check_part_definition and bim_save_part_definition.

Input: example

bim_check_part_definition ​

Dry run of a part definition: every problem in plain words (formulas, sketches that don't close or can't be solved, features without depth, connectors, each size in the types table), then for each size its type id, overall size, connector positions and sizes (warnings for one below the base, inside the body or facing into it), and plan / front / side previews as SVG. Saves nothing. Fix and re-check until status is ok, then save with bim_save_part_definition.

Input: part_name, definition, preview_type?, previews?

bim_read_part_definition ​

Open a part the way Edit part does: give a part type id (bim_list_part_types) or a placed part's id, get back part_name and definition in exactly the form bim_check_part_definition and bim_save_part_definition take (reference planes, sketches, features, connectors, parameters and the types table), its sizes and how many are placed. Change it, check, save with the same part_name.

Input: project_id, model_id, id

bim_save_part_definition ​

Save a modeled part (made with the part editor's model: reference planes, sketches, extrudes and revolves, connectors, a types table) to the project library. Each row of its types table becomes a placeable type with id <model id>.<size>; placed parts of an existing type update at once. Refused, with the reason, if the definition doesn't check out or if a run is connected to a connector it would remove or move.

Input: project_id, model_id, level?, zone?, base_revision?, part_name, definition

bim_list_firm_parts ​

Parts in the firm library, which every project can place: name, category, every size's type id, revision and where each came from (e.g. its cut sheet). Place one with bim_place_part, type_id = a size's type id and from_firm_library = true.

Input: search?, category?

bim_save_firm_part ​

Save a modeled part definition (from the part editor, bim_read_part_definition or bim_draft_part_from_cut_sheet) to the firm library, where every project can place it. A part with the same model id is replaced (its revision goes up; projects that already placed it keep their copy until they save it again). Refused, with the reason, if the definition doesn't check out. Pauses for approval.

Input: part_name, definition

bim_set_clearances ​

Space a part needs kept clear: service access, combustibles, economizer access, NEC 110.26 working space. Zones draw dashed, are never solid, move with the part; lint's clearance-intrusion reports anything inside one. scope type: zones replace the type's (every placed part follows). scope instance: overrides by zone id for this part (null clears; a full zone adds one). working_space computes depth/width/height from Table 110.26(A)(1) for the voltage and condition you choose.

Input: project_id, model_id, base_revision?, element_id, scope, zones?, overrides?, working_space?, dedicated_space?

bim_set_part_host ​

Say what parts stand on: one of our slabs (slab_id) or a linked model's slab/roof (linked: model id, name, top elevation, GlobalId if known; the lint block's near.host names the surface and its top), and the curb or rail height. By default each part moves onto it (base = top + curb) and connected runs follow as in a move (refused, naming the run, if one can't). remove_host takes it off. Lint's floating-equipment checks parts against their host; deleting our slab leaves them flagged 'nothing under it'.

Input: project_id, model_id, base_revision?, part_ids, slab_id?, linked?, remove_host?, curb_in?, seat?

bim_set_mounting_plane ​

A level surface at a height over a plan rectangle (feet) to place air devices on where there's no ceiling. A new height moves its parts; their duct follows.

Input: project_id, model_id, level?, zone?, base_revision?, plane_id?, level_id?, name?, height_above_level_ft?, corner1_x_ft?, corner1_y_ft?, corner2_x_ft?, corner2_y_ft?

Calculations ​

Family calcs: Code calculations, duct size advice, duct pressure and pipe hydraulics reports, pipe sizing and service size.

Turn it on: /packs/calcs/mcp, --packs calcs, or bim_enable_pack in a session.

bim_list_calcs ​

The calc plugins bim_run_calc can run, electrical (NEC 2020 / 2023), mechanical and plumbing: id, version, what it calculates and from what, whether it reads a model, a worked example input, and the input schema. Free; no approval.

Input: domain?

bim_run_calc ​

Run one calc plugin and get values with units, the steps in plain language, issues, and the clause or method each value rests on (e.g. "NEC 2023 Table 310.16, copper 90°C column", "NEC 2023 250.122(B)"). Examples: size a feeder (calc nec.size_circuit, inputs {circuit: "feeder", system: "3ph_4w", voltage_v: 480, continuous_load_a: 100, length_ft: 250}); a 277 V site lighting branch kept on a 20 A breaker and upsized for voltage drop (ocpd_a: 20); a panel or service demand load from its raw inventory (nec.demand_load); duct or pipe system reports (mech.duct_system_pressure, plumbing.pipe_system, give model_id). Code edition: nec_edition / plumbing_edition / fuel_gas_edition if given, else the project's Code Study, else state; otherwise it asks. bim_list_calcs shows every calc's inputs. Read-only; no approval.

Input: project_id, calc, inputs, nec_edition?, plumbing_edition?, fuel_gas_edition?, state?, model_id?, include_detail?

bim_suggest_duct_size ​

The smallest standard duct for an airflow at the system's friction rate and velocity limit (equal friction, Darcy-Weisbach with the system's design air and material, through the airway a liner leaves), with its velocity and friction; for rectangular duct also the narrowest width at a given depth. Give airflow_cfm, or element_id of a segment to use what it carries. check_* sizes report velocity and friction for a size you have in mind. Nothing changes: apply a size with bim_resize_run, bim_resize_stretch or bim_route_run.

Input: project_id, model_id, level?, zone?, airflow_cfm?, shape?, element_id?, system_id?, system_kind?, height_in?, insulation?, friction_in_per_100ft?, max_velocity_fpm?, max_aspect_ratio?, check_width_in?, check_height_in?, check_diameter_in?

bim_pressure_report ​

Static pressure for one duct system: each segment's CFM, velocity, friction rate and loss, each fitting's C (with its source), the critical path to the fan and the external static pressure the fan needs, in inches of water. Give system_id, or element_id of any run in it.

Input: project_id, model_id, level?, zone?, system_id?, element_id?

bim_pipe_report ​

Hydraulics for one pipe system. Domestic water: gpm, velocity, friction (Hazen-Williams or Darcy), fitting K or equivalent length, static head, pressure at every fixture and the critical one against the required pressure. Drainage: fixture units on every pipe and stack, design flow, capacity at its slope (Manning, partly full) and stack capacity. Fuel gas: cfh, drop by Spitzglass or Mueller, the longest run, the pressure at each outlet. Built-in values are labelled verify for permit work; firm tables apply when entered. Give system_id, or element_id of any pipe in it.

Input: project_id, model_id, level?, zone?, system_id?, element_id?

bim_set_fitting_coefficient_override ​

Record an engineer's own C on one fitting (body, or the branch / main path of a takeoff or pipe tee), with their name and the time; it wins over tables and formulas. On pipe it is the K the hydraulics report uses (water, gas; drains take none). c = null clears it.

Input: project_id, model_id, level?, zone?, base_revision?, path, c, set_by, note?, element_id?, fitting_id?

bim_size_pipes ​

Apply the sizes the system's calc proposes, recomputed at this revision, as one edit; reducers go where sizes change. Gas: plumbing.gas_system (zones, fuel gas tables). Water, sanitary, vent, storm: plumbing.size_system (demand curve; DFU tables; 906; roof area at the system's rainfall rate). Run the calc first and show the person the changes.

Input: project_id, model_id, base_revision?, system_id, allow_smaller?, method?, fuel_gas_edition?, plumbing_edition?, state?

bim_service_from_equipment_list ​

Reads an equipment schedule (paste, CSV or PDF text) into rows (line = non-blank line, header counted) with VA and a suggested NEC load class, then sizes the service by Article 220 with the trail: required_a is the minimum ampacity (noncontinuous + 125% of continuous; lighting and fixed space heating are continuous), service is the next standard rating at or above it. Show the suggestions; send the person's corrections in classes. Read-only.

Input: project_id, text, voltage_v, phases, classes?, occupancy?, spare_pct?, nec_edition?

Schedules ​

Family schedules: Define schedules, edit their cells and manage the schedule library.

Turn it on: /packs/schedules/mcp, --packs schedules, or bim_enable_pack in a session.

bim_schedule_fields ​

What a schedule can list and show. No classes: every class by discipline. With classes: each one's fields (path, label, kind, unit, edit instance/type or why locked, how it totals) and relationships (serves, source, fed_from…) for aggregate and expand columns. Read-only.

Input: project_id, classes?

bim_schedule_define ​

Create a v2 schedule (definition, or a library template id) or replace an existing schedule view's definition; place_on puts a new one on a sheet in the same edit. Preview first: problems in plain words, the first rows, a preview_token. Commit with user_confirmed (pauses for approval).

Input: project_id, model_id, base_revision?, schedule?, name?, definition?, steps?, template?, form?, place_on?, preview_token?, user_confirmed?

bim_schedule_edit_cells ​

Change cells of a schedule (row_key and column id from bim_schedule_read; quantities with a unit, e.g. "199 MBH"). Each cell goes back through its field to the model; locked or wrong values are refused in plain words. Preview first: the changes, every type-wide edit as "WH-1 type: 14 parts", a preview_token. Commit with user_confirmed (pauses for approval; one undo step).

Input: project_id, model_id, base_revision?, schedule, edits, preview_token?, user_confirmed?

bim_library ​

The firm's named calculations, shared fields, classes and schedule templates. list (scopes and items), read (an item and its pin for a schedule's pins), test (validate an item, run its examples), publish (to firm or project scope: preview first, then user_confirmed; pauses for approval and needs firm library write access).

Input: project_id, action, type?, text?, id?, revision?, item?, scope?, base_revision?, preview_token?, user_confirmed?

Apache License 2.0. The reference is generated from the code on every change.