# Carbone API API

> Carbone API API on Apizie: 6 endpoints (Retreive a generated document from a render ID., Generate a document from a template ID, and a JSON data-set, Fetch the API status and version, Upload a template., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/dev-tools:carbone/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `dev-tools:carbone`
- Category: Dev Tools
- Status: byok
- Source: https://help.carbone.io
- Page: https://www.apizie.tech/api/dev-tools/carbone
- OpenAPI: https://www.apizie.tech/api/dev-tools/carbone/openapi.json

Carbone Cloud/On-premise Open API reference. For requesting: - Carbone Cloud API: find your API key on your [Carbone account](https://account.carbone.io). Home page > Copy the `production` or `testing` API key. -…

## Endpoints

### Retreive a generated document from a render ID.
`GET https://www.apizie.tech/v1/dev-tools:carbone/get-render-render-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| renderId | string | yes | Unique identifier of the report |
| carbone-version | integer | yes | Carbone version |

### Generate a document from a template ID, and a JSON data-set
`POST https://www.apizie.tech/v1/dev-tools:carbone/post-render-template-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| templateId | string | yes | Unique identifier of the template |
| carbone-version | integer | yes | Carbone version |
| body | object | yes | JSON request body |

### Fetch the API status and version
`GET https://www.apizie.tech/v1/dev-tools:carbone/get-status` (byok)

### Upload a template.
`POST https://www.apizie.tech/v1/dev-tools:carbone/post-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| carbone-version | integer | yes | Carbone version |
| body | object | yes | JSON request body |

### Download a template from a template ID
`GET https://www.apizie.tech/v1/dev-tools:carbone/get-template-template-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| templateId | string | yes | Unique identifier of the template |
| carbone-version | integer | yes | Carbone version |

### Delete a template from a template ID
`POST https://www.apizie.tech/v1/dev-tools:carbone/delete-template-template-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| templateId | string | yes | Unique identifier of the template |
| carbone-version | integer | yes | Carbone version |

## Example
```
curl "https://www.apizie.tech/v1/dev-tools:carbone/get-render-render-id" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Carbone API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/dev-tools:carbone/get-render-render-id with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Carbone API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Carbone API itself also needs your own key from carbone.io.

### Can AI agents use the Carbone API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key dev-tools:carbone.

### What is the status of the Carbone API API?
Needs your own provider key (bring your own key)