> ## Documentation Index
> Fetch the complete documentation index at: https://docs.speckle.systems/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> These docs describe Speckle as it works today, including everything released in 2026.9. Treat page content as current unless the page or section says it applies only to versions published before 2026.9.
> Content scoped to versions published before 2026.9 (the object graph and root object, Proxies, Receive2, operations.receive, object.children) applies only to model versions in that earlier data format. For versions published in 2026.9, answer from the Object model pages and the SDK migration guides.
> The What's new pages summarise what changed in 2026.9 and link to the page that documents each change. Answer from the linked page rather than from the summary. Legacy (v2) connectors are retired; send questions about them to the community help forum.
> Match guidance to the customer's deployment, model data format, connector, plan and permissions. Self-hosted servers on a release before 2026.9 and compatibility-mode workflows follow the Compatibility mode page. If an unknown version or data format changes the answer, ask one focused question; do not infer the deployment version from the date alone.

# Create and share Intelligence Reports

> Edit report layouts, change sources and knobs, use tabs, compare versions, and revoke share links.

A **Report** is a saved artefact under **Reports** in the project sidebar. Speckle Intelligence
**Chat** builds it from a conversation. The viewer sparkle does not create a Report.

Open the report to edit the layout, change sources and knobs, add tabs, compare versions, and share
a link. Viewing a report, or changing its interactive inputs, does not spend AI credit. Chat turns
that create or edit the report do.

For asking questions and building the first draft in Chat, see [Ask questions about your models with
Speckle Intelligence](/analytics/intelligence). This page covers the report after you save it.

Reports and [Dashboards](/analytics/intelligence-dashboards) are distinct products. Dashboards are
built by hand; Reports are generated from an Intelligence Chat conversation. If you have a Dashboards workflow that shapes what you'd
want from Reports, [tell us on the forum](https://speckle.community).

<Note>
  On a self-hosted Speckle Enterprise Server, your server administrator turns on Intelligence and
  connects it to your organisation's AI provider. See [Enable
  Intelligence](/developers/server/deployment/enterprise-license#enable-intelligence).
</Note>

## Create a report

In **Chat**, ask Speckle Intelligence to produce the analysis you want, then save the result as a
**Report**. The sparkle in the 3D viewer cannot create a saved Report.

Open **Reports** in the project sidebar to find saved reports. The breadcrumb reads **Reports**, then
the report name. If the report is missing, the page reads **Report not found.**

## Open and edit

Select a report to open it. Edits stay local until you save. There is no auto-save.

Use **Add** to insert **Chart**, **KPI**, **Table**, **Viewer**, or **Text**. With a section
selected, the widget lands in that section. Otherwise Speckle appends a new section. **Add** opens
Chat and pins the new block so the next message can target it.

The toolbar can show **Saving…**, **Unsaved changes**, **Saved**, or **Save failed**. Use **Save**
to keep changes, or **Discard**. Leaving with unsaved edits prompts **Leave without saving?**

The toolbar also offers **Undo** and **Redo** for layout edits made in the editor. Undo does not
apply to AI turns — those changes land as a new edit state you can undo or discard.

**Share** stays disabled while the report is unsaved. The tooltip reads **Save or discard your
changes to share this report.**

The **⋯** menu (**More actions**) offers **Open source chat** when you created the report from Chat
and you are the creator, plus **Rename** and **Delete**. Delete cannot be undone.

### Properties panel

Clicking any element in the editor opens the **Properties** panel on the right. What you see depends on what is selected.

**Section** — Set **Title**, **Show title**, **Subtitle**, and **Show subtitle**. Drag the section
using the grip in its menu. Convert a plain section to a tabbed section with **Add tabs**, or add
another tab to an existing tabbed section with **Add tab**.

**Row** — Set **Height** (in pixels) to control how tall the row renders. A row can contain
multiple cells side by side.

**Widget** — Set a **Title** (required) and optional **Description**. For charts, you can also
switch the **Chart type** between bar, line, and scatter — available on AI-generated charts only,
not hand-authored ones. Chart **Labels** lets you rename what the chart shows (axis labels, series
names) without affecting the underlying values; leave a field empty to keep the original.

Use Chat on the report page to ask the AI to create or rewrite content — those turns spend AI
credit. Direct edits in the Properties panel do not.

## Change sources and knobs

Reports have two **Inputs** surfaces. Name them both.

### Source chips

The header strip reads **Inputs · N sources** (or **1 source**). Each chip shows a model, version,
project, and alias, or a data source.

When you can edit, open **⋯** on a chip for **Change version…** (dialog title **Change version —
\{model}**), **Swap model…**, and **Revert to saved** when the working copy differs from the last
save.

### Section knobs

A section can show **Inputs (n)** with knobs such as a rate or occupancy. **Reset** restores each
knob to its saved default. A knob in one section can drive widgets in another.

Changing knobs does not spend AI credit. Ask Chat to create or rewrite the report if you need new
structure.

## Use tabs

A section can be **tabbed**. Each tab has its own row stack of widgets.

In **Properties** for that section, use **Add tab** or **Add tabs**. Those controls are not in the
widget **Add** menu. Rename a tab by editing its label inline.

## Compare versions

There is no separate **Version diff** button. Bind two source aliases — two versions of one model,
or two models — from the **Inputs** strip. Widgets and Chat can compare those aliases.

You cannot remove a source that a comparison widget still uses. Change the version on a chip to
retarget the comparison.

## Share and revoke a link

Select **Share** to open **Share report**. Access uses the same three levels as Chat sharing:

* **Private** — only the owner
* **Project** — anyone in the project can open and view. The description reads **Anyone in \{project}
  can open and view this report.**
* **Public** — a link anyone can open without signing in

Public links warn that anyone with the link can view the report — including the model data behind
its sections. Edits to the report update what the link shows and can read. No sign-in is required.

The public token is scoped to the versions the report's sources bind. Speckle shows the raw token
**once** when you create the link. Optional password and expiry apply at create time.

Turning project sharing off does **not** revoke public links. Those links are independent. Revoke a
public link from **Share report**, or from **Project settings** → **Tokens**.

If you are not the owner, the dialog reads **You're viewing a report someone shared. Only its owner
can change sharing.**

<Tip>Save before you share. Unsaved edits block **Share**.</Tip>

<Tip>
  Do not rely on switching the report to private to kill a public URL. Revoke the public link.
</Tip>

## FAQ

<AccordionGroup>
  <Accordion title="Does opening a report spend AI credit?">
    No. Viewing a saved report, or changing its interactive inputs, does not spend AI credit. Chat
    turns that create or edit the report do.
  </Accordion>

  <Accordion title="Can the viewer sparkle create a Report?">
    No. Only **Chat** in the project sidebar can build a saved **Report**. The sparkle answers
    beside the model. See [Ask questions about your models with Speckle
    Intelligence](/analytics/intelligence).
  </Accordion>

  <Accordion title="I turned off project sharing. Why does the public link still work?">
    Project visibility and public links are independent. Turning project sharing off does not revoke
    public links. Revoke the link from **Share report** or **Project settings** → **Tokens**.
  </Accordion>

  <Accordion title="Why is Share disabled?">
    Save or discard unsaved changes first. The tooltip reads **Save or discard your changes to share
    this report.** You also need permission to share.
  </Accordion>

  <Accordion title="Who can edit a report?">
    Editors with permission see **Add**, **Save**, **Discard**, and source **⋯** actions. Viewers
    can open the report and change knobs when inputs exist. Only the owner changes sharing.
    Non-owners see **You're viewing a report someone shared. Only its owner can change sharing.**
  </Accordion>
</AccordionGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.