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

> ## Agent Instructions
> getclean's own MCP server is at https://mcp.getclean.ai/mcp. The /mcp path of this docs site is Mintlify's search over these pages, not getclean.
> Every answer of the API opens with outcome. A page that could not be read is a record whose outcome says why, never an HTTP error; read outcome before anything else.
> The API's contract is the OpenAPI 3.1 file at https://docs.getclean.ai/openapi.yaml; the SDKs are generated from it.
> The product's name is written getclean, in lower case.

# Emissions data with a source for every cell

> Fill one template from 300 sustainability reports, 20 in a call. Each cell comes with the words and the page it was taken from, and an empty cell says whether the company does not report the figure or the page was not read.

An analyst builds a table of the emissions of 300 companies from their sustainability reports. Cells go wrong in 3 ways. A number is taken from the wrong year's column. A cell is left empty where the report states the figure on a scanned page. And a cell is filled with a plausible number where the company reports nothing. A client finds one of them, and the whole table is in doubt. This page builds a table in which each cell names its page, and each empty cell says why it is empty.

## The run in 4 steps

### Send one template with 20 reports

A batch takes 20 addresses and one template. Each report is fetched, and the same fields are filled from each.

```json Request body of fetch_contents_batch, cut to 2 of 20 items theme={"theme":"css-variables"}
{
  "items": [
    { "label": "first-company-2025", "url": "FIRST_REPORT_URL" },
    { "label": "second-company-2025", "url": "SECOND_REPORT_URL" }
  ],
  "json_schema": {
    "type": "object",
    "properties": {
      "reporting_year": { "type": "integer" },
      "scope_1": {
        "type": "string",
        "description": "Direct emissions of the reporting year, with their unit"
      },
      "scope_2_market_based": {
        "type": "string",
        "description": "Scope 2 emissions by the market-based method, with their unit"
      },
      "scope_3": {
        "type": "string",
        "description": "Scope 3 emissions of the reporting year, with their unit"
      },
      "scope_1_prior_year": {
        "type": "string",
        "description": "Scope 1 emissions of the year before, as this report states them"
      },
      "assurance_provider": {
        "type": "string",
        "description": "The firm that gave assurance on the emissions data"
      },
      "net_zero_target_year": { "type": "integer" }
    }
  },
  "max_characters": 0
}
```

Replace the 2 placeholders that end in `_URL` with the address of each report. A label is your own name for a report, such as the company and the year.

### Read each cell with its place

Each field of each report comes back with a status. This response is one report, cut to the status, the words, and the place of each field.

```json Part of the response theme={"theme":"css-variables"}
{
  "schema_statuses": {
    "/reporting_year":        { "status": "found", "text": "Reporting period: 1 January to 31 December 2025", "page_label": "4" },
    "/scope_1":               { "status": "found", "text": "184,200", "page_label": "62", "row": 2, "column": 1 },
    "/scope_1_prior_year":    { "status": "found", "text": "191,700", "page_label": "62", "row": 2, "column": 2 },
    "/scope_2_market_based":  { "status": "found", "text": "96,450", "page_label": "62", "row": 4, "column": 1 },
    "/scope_3":               { "status": "absent" },
    "/assurance_provider":    { "status": "unread" },
    "/net_zero_target_year":  { "status": "found", "text": "net zero across our value chain by 2040", "page_label": "11" }
  }
}
```

The 2 figures for Scope 1 come from one row of one table on page 62, and each names its column. So the figure of 2025 and the figure of the year before cannot change places.

The report says nothing about Scope 3, which is `absent`. "The company does not report Scope 3" is a finding that your table can state. The assurance provider is `unread`: it could be on a page that was not read, so that cell goes to a person and is not printed as "none".

### Find the restated figures

A report gives last year's figure again beside this year's, and sometimes it is no longer the figure that last year's report stated. Your table has both: `scope_1_prior_year` from the report of 2025, and `scope_1` from the report of 2024. Where the 2 differ, the company restated the figure, and each of the 2 numbers has its page.

### Read the table behind a cell

A cell names its row and its column. To show a reader what the row is, read that table from the stored record, cell by cell with its headings. A stored record is read again at no charge.

## What the client can check

| The client asks | What the table has |
| - | - |
| Where is this number from? | The report, the page, and the row and the column of its table. |
| Is the cell empty because nothing is reported? | `absent` or `unread`, for each empty cell. |
| Was a figure restated? | The 2 figures of one year, each from its own report. |
| Which pages were not read? | The pages that failed, and the scanned pages read with a low confidence. |

## Know the limits

A model fills the template, and each value is bound to words of the report. A value comes as the report states it: nothing is converted, so "184,200 tCO2e" and "184.2 kt" are 2 strings until your code makes them one unit.

A figure that a report shows only in a chart is not read, because the text inside an image is not read on a document that has text of its own.

The row and the column of a cell are there where the file has the table's structure. A table of a scan or of a PDF without structure comes as text, and the cell then has its page and its words.

For the calls, see [Fill your fields, each with the words it came from](https://docs.getclean.ai/read/extract-fields-with-citations.md) and [Fetch 20 sources at once and know what came back before you read a word](https://docs.getclean.ai/read/many-pages-at-once.md).


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