Breeks Documentation
Application docs for the construction project memory and coordination platform.
System of record
Project truth lives in Breeks Core API, not in agent memory.
Permissioned tools
Agent actions use explicit endpoints with project and actor context.
OpenAPI first
The API reference is generated from the current FastAPI schema.
What the record holds
One typed catalog — not a folder of attachments.
Whatever channel it arrives on, a coordination item becomes a record and a project file becomes a document. Each has a type, and each type carries its own workflow. RFIs and drawings ship today; the rest of the catalog is on the way.
Records
1 liveCoordination items the team raises, routes, and closes.
- RFIRequest for informationLive
- MINMeeting minutesPlanned
- DEFDefectsPlanned
- SAFSafety itemsPlanned
- APRApprovalsPlanned
Documents
1 liveProject files held with their revisions and markups.
- DWGDrawingsLive
- MATMaterialsPlanned
- SPCSpecificationsPlanned
The drawing viewer keeps Details, Annotations, Comments, and Activity in its inspector, with Versions for drawing revisions. Comments preserve correspondence and contributor names; Activity shows the audit trail.
Use Share in Documents to give access to one exact revision. Choose Unverified users (no sign-in) or Registered users (sign-in required), independently of Read-only, Comment + markup, or Edit access. Links expire after seven days by default; creating a link does not send it. Markup needs a saved page preview, and superseded revisions are read-only.
The separate /ask utility saves a page mark and question as a drawing comment after sign-in. Share comment explicitly publishes that question and selected full page; recipients reply without an account, and replies appear in drawing comments. Guided “Ask for markup” requests are retired; existing request history remains available to authorized members.
Nothing changes off the record
Durable truth, because every path is guarded.
Controlled access
Workspace access follows project roles. Shared items enforce the link's audience and permission on each request, without granting project membership.
Written to the log
Every meaningful change appends an entry — who, what, when. The history is the record, and it only grows.
Structured paths only
Whether a person types it or Breeks acts on it, every write goes through the same owned routes — never free-text. The agent has no privileged back door.
Start with a drawing.
Upload from the homepage, then sign in or create an account with Google or email/password. New accounts get a private Default project with drawing and RFI types. Password signup needs no mailbox verification. Your drawing opens on page 1 in Documents; saving it does not create or publish a question.
API Reference
113 operations in the module index
Browse the full generated reference, including account, sharing, and compatibility routes.
MCP Connection
Connect agents to Breeks tools
Configure Streamable HTTP, bearer auth, tool envelopes, project resources, and prompts.
AI Gateway
Configure providers and models
Manage provider credentials, model dropdowns, active routing, and document-processing fallbacks.
Auth
11Session login and current-user lookups.
Invitations
6Project invitation preview, acceptance, creation, and revocation.
Projects
16Project onboarding, context, companies, dashboard, schedules, and audit activity.
Members
12Users, project members, channel accounts, and identity resolution.
Record Types
6Project record type definitions and reusable record templates.
Tags
3Tag catalog endpoints for records and documents.
Records
13RFI-first record CRUD, comments, tags, and drawing links.
Tasks
7Kanban work item CRUD, status movement, assignment, and comments.
Documents
36Drawing upload, metadata search, pages, tags, annotations, and record links.
Agent
2Agent-facing tool invocation and project-scoped agent activity.
Health
1Service health check endpoints.