Bring ForemanAI’s sheet-aware reasoning into your internal dashboards, ERPs, or ConTech products. Every response cites the source sheet, callout, and condition summary so your teams can trust the output.
Base URL
https://api.foremanai.co
Auth
Bearer token
Formats
JSON in / JSON out
Quickstart
Four steps to wire in ForemanAI.
Create an API key
Contact the ForemanAI team for a scoped token tied to your workspace.
Upload or reference a plan
Use the web app upload or the plan-files endpoint to register sheets.
Submit an analysis job
POST to /api/v1/plan-analyses with the modes (conflicts, rfis, schedule, metadata).
Consume the results
Poll the /api/v1/plan-analyses/<id> resource or subscribe to webhooks for completion events.
Authentication
Bearer tokens with workspace scopes.
Include the header Authorization: Bearer <token> in every request. Tokens map to a workspace and can be limited to read-only, plan submission, or admin scopes.
Environment separation · Sandbox and production tokens are issued separately.
IP and org controls · Optional allowlists keep access limited to your network.
Rotation cadence · Rotate every 60 days or on-demand via the admin console.
Request patterns
Choose the workflow that fits your crews.
Plan analyses
Kick off full sheet reviews
Use when you want conflicts, RFIs, schedule checks, and metadata in a single pass.
plan_id from the uploaded set
modes array: conflicts, rfis, schedule, metadata
Optional notes to direct ForemanAI toward areas of concern
Inline questions
Ask about a specific sheet
Route quick Q&A to the /api/v1/plan-questions endpoint when you only need a citation-backed answer.
Send question, sheet_hint, and optional discipline
Responses cite the sheet, viewport, and callout used
Great for embedding in field or PM dashboards
Bulk sync
Mirror the vault in your system
Use plan-files plus pagination on conflicts to hydrate your BI tools or compliance archives.
All endpoints return deterministic IDs for delta syncing
Webhooks notify you when new conflicts exceed thresholds