CarbonAPI

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.

Can I limit what my agent is allowed to do with the CarbonAPI?

Yes. Because you run Jentic One yourself, your own rules decide which CarbonAPI operations and credentials the agent may use, so you scope access by operation. CarbonAPI creates a batch from the request body and reads it back by its batchId, which means you can allow the agent to submit a transaction batch (POST /v1/transactions/batch) and read its result (GET /v1/transactions/batch/{batchId}) while leaving the document batch calls out of the allowed set. Your CarbonAPI key stays with your instance and is injected only when a permitted operation runs, so the agent can only call the endpoints you have approved.