pyrevitlabs/pyrevit/pyrevit-library

pyrevitlib and rpw

pyRevit ships two maintained libraries that agent scripts can import on every engine. Use them first: their functions handle version differences, engine quirks and the Revit API traps agents fall into. Write raw DB. code only for what they don't cover.

Finding a function

lookup_pyrevit_api searches both libraries from their source, without Revit:

• lookup_pyrevit_api(query="section box") searches names and docstrings.
• lookup_pyrevit_api(query="create_gable_roof") returns the signature, the full docstring and the import line.
• lookup_pyrevit_api(query="pyrevit.revit.db.create") lists a module.
• list_automation(offset=0, limit=25) lists reviewed APIs with stable IDs, effects, context and transaction requirements. Use an ID with lookup_pyrevit_api to read its full contract.
• run_automation(id=..., inputs=...) runs a small reviewed subset through the existing guarded query path. It currently accepts pyrevit.units.parse-length and pyrevit.units.parse-slope, each with {"value": ...}; pyrevit.levels.resolve with {"name": ...}; and pyrevit.elements.by-category with {"categories": ["OST_Walls"], "limit": 50}. The document-bound operations require an active document.

When a script fails on a name from these libraries, the error hint lists similar names.

Where things live

from pyrevit import revit
from pyrevit.revit.db import query, create, update
from pyrevit.revit import units, ui

Functions that create elements take points as DB.XYZ or (x, y[, z]) tuples, and lengths as feet or strings such as 32'-6" and 900mm. Types, levels and family types can be passed by name.

Revit's own utility classes

When the libraries don't cover a step, Revit may still have it in a static ...Utils class that isn't reachable from the element: wall joins, face references for hosting, solid booleans, MEP caps and terminal connections, beam end joins, unit formatting, worksharing. Read get_skill("pyrevit-library", "revit-utilities.md") before writing the geometry or connection logic yourself, and before concluding that the API can't do something.

Rules

• Libraries first, raw API second. Look the task up with lookup_pyrevit_api before writing DB. code for it.
• Prefer `find_*` to `get_*` in agent scripts. get_* returns None and the script carries on; find_* stops with the names that exist.
• Don't use `pyrevit.forms` or `rpw.ui.forms`. Agent runs have no user to answer a dialog.
• Report library gaps. If a common step has no function, say so in your answer; the maintainers add missing functions to the libraries.