CarbonAPI Documentation
API ReferenceDocument Analysis

Get the document batch

GET
/document/batch/{id}
x-api-key<token>

In: header

Scope: api_key

Path Parameters

idstring

Response Body

curl -X GET "https://api.aws-au.carbonapi.io/document/batch/string"
{
  "status": "completed",
  "documents": [
    {
      "status": "completed",
      "category": "FUEL",
      "totalTokens": 1500,
      "country": "US",
      "reference": "DOC-001",
      "financial": {
        "total": 1000,
        "subtotal": 900,
        "tax": 100,
        "supplier": "ABC Corp",
        "customer": "XYZ Ltd",
        "currency": "USD"
      },
      "items": [
        {
          "periodFrom": "2023-03-01T00:00:00",
          "periodTo": "2023-03-31T23:59:59",
          "reference": "REF-001",
          "description": "Electricity consumption for office building",
          "quantity": 1000,
          "unit": "kWh",
          "emissionFactorId": "ef-001",
          "inference": 0,
          "steps": [
            "Calculate the emissions for the electricity used.",
            "Apply transmission and distribution losses."
          ],
          "hash": "abc123def456",
          "emissionFactor": {
            "code": "ACTIVITY_SCOPE2_ELECTRICITY_USAGE_ELECTRICITY_USED",
            "name": "Electricity Used",
            "yearOrDefault": "2023",
            "sourceName": "EPA",
            "sourceUrl": "https://www.epa.gov/emission-factors"
          },
          "emissions": {
            "co2e": 1.5,
            "co2": 1.2,
            "ch4": 0.1,
            "n2o": 0.2
          },
          "isSideEffect": false,
          "meta": {
            "key": "value"
          }
        }
      ]
    }
  ]
}