CarbonAPI

Name: CarbonAPI API
Brand: CarbonAPI
Availability: InStock

★ Only Publicly Available OpenAPI DocumentData EnrichmentData TransformationapiKey4 EndpointsREST

For Agents

Submit document and transaction batches to calculate greenhouse-gas emissions for spend-based carbon accounting and freight reporting.

Install Jentic One Beta

Connect the CarbonAPI to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the CarbonAPI, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with CarbonAPI API.

Submit a batch of receipt and invoice documents for emissions analysis

Retrieve the calculated emissions and extracted line items for a document batch by batch ID

Submit a batch of structured transactions for category-based emissions estimation

GET STARTED

Start building with CarbonAPI API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for CarbonAPI, keeping it validated and agent-ready. CarbonAPI is a carbon accounting service that enriches expense, supplier, and freight data with calculated greenhouse-gas emissions. It accepts batches of documents (invoices, receipts, bills) for emissions analysis and batches of structured transactions for category-based emissions estimation, returning kgCO2e values that map to standard carbon-accounting frameworks. Agents can use it to compute the footprint of business spend, freight movements, or supplier activity at scale.

Use Cases

Patterns agents use CarbonAPI API for, with concrete tasks.

★ Spend-Based Emissions Reporting

Convert a finance system's transaction export into a carbon footprint report. Agents post a transaction batch to POST /v1/transactions/batch, then poll GET /v1/transactions/batch/{batchId} for the calculated kgCO2e per transaction. CarbonAPI applies category-based emission factors and returns results that can be aggregated into Scope 1, 2, and 3 dashboards for sustainability reporting.

Post a transaction batch of last month's expenses, poll until processing completes, then return total kgCO2e grouped by category.

Receipt and Invoice Footprint Analysis

Run document-level emissions analysis on receipts and invoices. POST /v1/documents/batch accepts a batch of documents, and GET /v1/documents/batch/{batchId} returns the extracted line items and their calculated emissions. This lets an expense-management or accounting agent attach kgCO2e to every expense without manual categorisation.

Upload 50 receipts as a document batch, wait for processing, and return the top three highest-emission line items.

Freight Emissions for Logistics Reporting

Calculate the emissions of freight movements by submitting them as transactions. CarbonAPI supports freight emissions calculation as part of its transaction batch processing, returning kgCO2e per shipping leg. This feeds logistics dashboards and ESG disclosures with auditable freight footprint figures.

Submit a transaction batch containing freight legs from origin to destination ports and return total kgCO2e.

AI Agent Carbon Accounting via Jentic

Wire CarbonAPI into an agent through Jentic so a CFO or ESG lead can ask 'what is our footprint for Q1?' and the agent fetches the calculation. Jentic returns the right batch endpoint and schema, holds the API key in its vault, and orchestrates the submit/poll cycle so the agent does not need to maintain integration code.

Through Jentic, submit a transaction batch and return the calculated total kgCO2e once results are ready.

Key Endpoints

4 endpoints — jentic publishes the only available openapi specification for carbonapi, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/v1/documents/batch

Create a document batch for emissions analysis

GET

/v1/documents/batch/{batchId}

Get processed document batch results

POST

/v1/transactions/batch

Create a transaction batch for emissions calculation

GET

/v1/transactions/batch/{batchId}

Get processed transaction batch results

POST

/v1/documents/batch

Create a document batch for emissions analysis

GET

/v1/documents/batch/{batchId}

Get processed document batch results

POST

/v1/transactions/batch

Create a transaction batch for emissions calculation

GET

/v1/transactions/batch/{batchId}

Get processed transaction batch results

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

CarbonAPI keys are stored encrypted in Jentic's vault. Agents receive scoped execution rights only — the key is injected into the Authorization header at request time and never enters the agent's context window or chat logs.

Intent-based discovery

Agents search Jentic by intent (e.g., 'calculate emissions for transactions') and Jentic returns the matching CarbonAPI operation with its input schema, so the agent picks the right batch endpoint without parsing docs.

Time to first call

Direct CarbonAPI integration: 1 day for batch submit/poll wiring and result aggregation. Through Jentic: under 30 minutes — search, load, execute.

FAQs

Specific to using CarbonAPI API through Jentic.

Why is there no official OpenAPI spec for CarbonAPI?

CarbonAPI does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call CarbonAPI via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the CarbonAPI use?

CarbonAPI uses an API key passed in the `Authorization` header on every request. Through Jentic the key is stored encrypted in the credential vault and injected at execution time, so the raw key never appears in the agent's prompt or chat history.

Can I calculate freight emissions with CarbonAPI?

Yes. Freight emissions are handled through the transaction batch endpoint — submit shipping legs as transactions to POST /v1/transactions/batch and CarbonAPI returns the calculated kgCO2e for each leg in the batch result available at GET /v1/transactions/batch/{batchId}.

Is CarbonAPI synchronous or asynchronous?

CarbonAPI is asynchronous and batch-based. POST endpoints accept a batch and return a batchId; the actual emissions calculation runs in the background. Poll the matching GET /v1/{type}/batch/{batchId} endpoint until the batch reports as processed before reading results.

What are the rate limits for the CarbonAPI?

The OpenAPI specification does not declare explicit rate limits. Limits are tied to the plan associated with your API key — keep batch sizes reasonable and back off on 429 responses. Contact CarbonAPI support for the quota tied to your account.

How do I submit a transaction batch through Jentic?

Run `pip install jentic`, then use Jentic's search to find the transaction batch operation with the query "calculate emissions for transactions", load the schema, and execute with your transaction array. Jentic calls POST /v1/transactions/batch, attaches your CarbonAPI key from the vault, and returns the batchId you can poll.

What's the difference between the documents and transactions endpoints?

The /v1/documents/batch endpoints take unstructured receipts and invoices and extract line items before calculating emissions. The /v1/transactions/batch endpoints take already-structured transaction records (amount, category, supplier) and apply category-based emission factors directly. Use documents when starting from PDFs/images, and transactions when starting from your finance system.

CarbonAPI

Connect the CarbonAPI to your agent

Capabilities

Start building with CarbonAPI API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs