Extract a construction plan takeoff
run_takeoffStarts a paid takeoff on a project whose plan PDF was attached with attach_plan_pdf or uploaded by the user on the project page in Portravo. Each trade uses one takeoff credit (bought at $75); the whole job uses three ($149 pay as you go). Uses only existing plan allowance and purchased credits, never billed overage. Prerequisites: preflight_takeoff, the user's approval of its trades and creditsRequired, and an attached plan; set confirmed_trades to the approved selection and max_credits to the approved ceiling (defaults to one for older clients). A changed selection/cost or insufficient balance is refused before starting. Repeating a call with the same idempotency_key does not charge again. Returns asynchronous progress; use get_takeoff_status until done, then get_takeoff for source-linked human review. A completed run is not a bid-ready estimate. Failed provider runs refund the reservation; existing review work cannot be overwritten.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"project_id": "<project_id>",
"confirm_credit_use": "<confirm_credit_use>",
"idempotency_key": "<idempotency_key>"
},
"name": "run_takeoff"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | ||
| max_credits | No | ||
| idempotency_key | Yes | ||
| confirmed_trades | No | ||
| confirm_credit_use | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| lines | Yes | ||
| sheets | Yes | ||
| scopeNotes | Yes |