Examples

What a full setup
looks like

Brickwren is an example property management platform, written for this page: 14 help articles and an API with 14 operations. Both went through Orrin’s engine, the same code a workspace runs. Every answer, source and preview below is its output, word for word.

The inputhelp.brickwren.example

Help center

14 help articles

  • Record a rent payment
  • Late fees
  • Rent reminders
  • Online payments and autopay
  • Create a work order
  • Assign a vendor
  • Work order statuses
  • Schedule an inspection
  • Renew a lease
  • Move a tenant out
  • Security deposits
  • Owner statements
  • Team roles and permissions
  • Reports

API · OpenAPI 3

Brickwren API 2.4, 14 operations

  • GET/unitsReadOn
  • GET/tenants/{tenant_id}ReadOn
  • GET/tenants/{tenant_id}/ledgerReadOn
  • POST/paymentsSensitiveOff
  • POST/charges/{charge_id}/waiveSensitiveOn
  • GET/work-ordersReadOn
  • POST/work-ordersWriteOn
  • PATCH/work-orders/{work_order_id}WriteOn
  • DELETE/work-orders/{work_order_id}SensitiveOff
  • POST/inspectionsWriteOn
  • POST/remindersSensitiveOn
  • POST/leases/{lease_id}/renewal-offersSensitiveOff
  • POST/deposits/{deposit_id}/refundsSensitiveOff
  • GET/reports/rent-rollReadOn

Orrin saw

14 articles, indexed as 14 passages. 14 operations, labelled 5 Read, 3 Write and 6 Sensitive from their methods and wording. Brickwren switched on 10 and kept 4 off: record a payment, cancel a work order, send a renewal offer and refund a security deposit.

The output: answersWord for word

Cites every answerPreviews before it actsSays when it is not covered

Ask

How do I waive a late fee for a tenant?

To waive a late fee, open the tenant's ledger, select the fee and choose Waive fee.1

  1. 1

    Late fees

    To waive a late fee, open the tenant's ledger, select the fee and choose Waive fee.

    0.79
  2. 2

    Team roles and permissions

    Sensitive permissions such as Waive fees, Approve refunds and Export data are off by default for every role except Owner.

    0.29
  3. 3

    Record a rent payment

    The rest of the balance stays on the ledger and can still be charged a late fee.

    0.26
  4. 4

    Online payments and autopay

    Tenants are invited to the tenant portal when their lease is created.

    0.20

Found 4 passages across 4 documents.

Ask

How much notice do tenants get before an inspection?

Tenants get at least 48 hours notice before a routine inspection by default.1

  1. 1

    Schedule an inspection

    Tenants get at least 48 hours notice before a routine inspection by default.

    0.75
  2. 2

    Move a tenant out

    Record the tenant's notice to vacate on the lease, with the move out date.

    0.53
  3. 3

    Security deposits

    Tenants can pay it in the tenant portal together with the first month's rent.

    0.52
  4. 4

    Renew a lease

    You get a reminder 90 days before a lease ends.

    0.48

Found 4 passages across 4 documents.

Ask

What happens if autopay fails?

If an autopay payment fails, autopay pauses and the tenant is asked to update their payment method.1

  1. 1

    Online payments and autopay

    If an autopay payment fails, autopay pauses and the tenant is asked to update their payment method.

    0.66

Found 1 passage across 1 document.

Ask

Can I edit a payment after the month is closed?

A payment cannot be edited once the month is closed.1

  1. 1

    Record a rent payment

    A payment cannot be edited once the month is closed.

    0.71
  2. 2

    Work order statuses

    After it is closed, a new work order is needed.

    0.41
  3. 3

    Online payments and autopay

    If an autopay payment fails, autopay pauses and the tenant is asked to update their payment method.

    0.37

Found 3 passages across 3 documents.

Ask · not covered

Is there a QuickBooks integration?

The documentation does not cover this. In a workspace, the question is logged as unanswered so the gap is visible on the Usage page.

Best passage scored 0.09, below the evidence threshold.

The output: action previewsNothing is sent

Act

Which units are vacant right now?

listUnitsRead

GET /units · List units

No required parameters. Optional: property_id, status, bedrooms. A read only call; it would run without a confirmation step. Execution is not enabled in this build.

No confirmation

Act

Create a work order for the broken heater in unit 3B

createWorkOrderWrite

POST /work-orders · Create a work order

Required: unit_id, category, description. Optional: priority, permission_to_enter. The user would review this preview and tap Confirm before it runs. Execution is not enabled in this build.

Confirmation required

Act

Waive the late fee for the tenant in 4B

waiveChargeSensitive

POST /charges/{charge_id}/waive · Waive a charge

Required: charge_id, reason. The user would type a confirmation word before this runs. Execution is not enabled in this build.

Confirmation required

Act

Send a rent reminder to every tenant with a balance

sendRentReminderSensitive

POST /reminders · Send a rent reminder

No required parameters. Optional: tenant_ids, property_id, channel. The user would type a confirmation word before this runs. Execution is not enabled in this build.

Confirmation required

Under the hood

Why that answer,
and not another

For “How do I waive a late fee for a tenant?”, these are the 6 passages Orrin ranked and the score each one got. Passages under 0.2 are set aside as weak evidence, at most four go forward, and only the sentences that clear a relevance bar reach the answer.

  1. 1Late fees0.79 Used
  2. 2Team roles and permissions0.29 Used
  3. 3Record a rent payment0.26 Used
  4. 4Online payments and autopay0.20 Used
  5. 5Move a tenant out0.17 Below the threshold
  6. 6Owner statements0.12 Below the threshold

Brickwren is an example company, not an Orrin customer. Its help center and API were written for this page, and any likeness to a real business is unintended. The answers, sources, scores and previews are Orrin’s real output, computed from them when this page was built. Running actions is not switched on yet, so no preview calls an API.

Your platform next

Try it on
your own help center