Skip to content
Browse all functions

1001fx account

AI

AI apps

Arrays

Audio & video

Carbone documents

Charts

Code

Data & JSON

Data tables

Date & time

E-invoices

Files & PDF

Geo

Images

Knowledge bases (RAG)

Playground

Spreadsheet

Stripe

Render Carbone Cloud Template

carbone/rendercarbonecloudtemplate

rendercarbonecloudtemplate (Render Carbone Cloud Template) is a 1001fx API function in the group Carbone documents: POST https://api.1001fx.com/carbone/rendercarbonecloudtemplate, 3 credits per call. It works as a ready-made module in n8n or as a plain HTTP call.

3 credits per callHTTP APIn8nService provider: Carbone.io

Renders a carbone clooud template by a given ID with specified data. Requires a Carbone Cloud API key.

  • This service is provided by an external service provider: Carbone.io. The data of the call is sent to the provider. More about service providers

Try it in the 1001fx app

Run rendercarbonecloudtemplate in your browser with your API key – fill the form, click Run and get the answer or the file.

rendercarbonecloudtemplate in the 1001fx app: the form with example values
Render Carbone Cloud Template in the 1001fx app

Endpoint

POSThttps://api.1001fx.com/carbone/rendercarbonecloudtemplate
Header
X-API-KEY: YOURSECRETAPIKEY How to
Content type
application/json

Parameters

  • apiKeystringrequired

    Your carbone.io API Key.

    Example:
    yourApiKey
  • templateIdstringrequired

    Your carbone.io template ID.

    Example:
    590c9afdfaafceca2133937b4939aaa554d828c4de0e6fc1e00427813238dbcf
  • dataobjectoptional

    Data to fill your template with. Either data or stringified data needs to be provided.

  • stringifiedDatastringoptional

    Stringified data to fill your template with.

    Example:
    {"companyName":"JohnInsurance & Co","period":2,"sD":1659041229,"id":2891,"insured":{"name":"Jean Michel","street":"23, Sycamore Street","city":"New York","phone":"+33 2 38 99 18 23"},"showPropertyDamage":false,"propertyDamage":[{"type":"Fire"},{"type":"Wind"},{"type":"Hail"},{"type":"Water"}],"options":[{"type":"Furniture","note":"/","cost":1200},{"type":"Appliances","note":"/","cost":400},{"type":"Clothing","note":"/","cost":300},{"type":"Dishes","note":"in some cases","cost":300}],"optionsTotalHT":2200,"optionsTaxes":10,"optionsTotal":2420}
  • outputFormatenumoptional

    Output format for your rendered template. Defaults to pdf.

    Values:
    pdf
    xslx
    docx
    ods
    csv
    txt
    odt
    Default:
    pdf
    Example:
    pdf

Examples

Get Carbone Template

Expects an apiKey und templateId

Input

Should return the template
{
  "apiKey": "yourApiKey",
  "templateId": "590c9afdfaafceca2133937b4939aaa554d828c4de0e6fc1e00427813238dbcf",
  "data": {
    "companyName": "JohnInsurance & Co",
    "period": 2,
    "sD": 1659041229,
    "id": 2891,
    "insured": {
      "name": "Jean Michel",
      "street": "23, Sycamore Street",
      "city": "New York",
      "phone": "+33 2 38 99 18 23"
    },
    "showPropertyDamage": false,
    "propertyDamage": [
      {
        "type": "Fire"
      },
      {
        "type": "Wind"
      },
      {
        "type": "Hail"
      },
      {
        "type": "Water"
      }
    ],
    "options": [
      {
        "type": "Furniture",
        "note": "/",
        "cost": 1200
      },
      {
        "type": "Appliances",
        "note": "/",
        "cost": 400
      },
      {
        "type": "Clothing",
        "note": "/",
        "cost": 300
      },
      {
        "type": "Dishes",
        "note": "in some cases",
        "cost": 300
      }
    ],
    "optionsTotalHT": 2200,
    "optionsTaxes": 10,
    "optionsTotal": 2420
  }
}

Output · HTTP 200

Result is a single file.
{
  "statusCode": 200,
  "headers": {
    "content-type": "application/pdf"
  }
}
Show curl command
curl -X POST 'https://api.1001fx.com/carbone/rendercarbonecloudtemplate' \
  -H 'X-API-KEY: YOURSECRETAPIKEY' \
  -H 'Content-Type: application/json' \
  -d '{"apiKey":"yourApiKey","templateId":"590c9afdfaafceca2133937b4939aaa554d828c4de0e6fc1e00427813238dbcf","data":{"companyName":"JohnInsurance & Co","period":2,"sD":1659041229,"id":2891,"insured":{"name":"Jean Michel","street":"23, Sycamore Street","city":"New York","phone":"+33 2 38 99 18 23"},"showPropertyDamage":false,"propertyDamage":[{"type":"Fire"},{"type":"Wind"},{"type":"Hail"},{"type":"Water"}],"options":[{"type":"Furniture","note":"/","cost":1200},{"type":"Appliances","note":"/","cost":400},{"type":"Clothing","note":"/","cost":300},{"type":"Dishes","note":"in some cases","cost":300}],"optionsTotalHT":2200,"optionsTaxes":10,"optionsTotal":2420}}'

Try rendercarbonecloudtemplate now

Run it in your browser or create a free account and get 100 credits every month.

Try it in the appGet your free API key

More in Carbone documents

Changelog

  • 1.0.017.04.2023created
Ask 1001fx