---
canonical_url: "https://docs.composio.dev/toolkits/apitemplate_io"
markdown_url: "https://docs.composio.dev/toolkits/apitemplate_io.md"
product: "platform"
version: null
last_updated: null
---

# Apitemplate

APITemplate.io provides APIs for generating PDFs and images from reusable templates using JSON data.

- **Category:** documents
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 12
- **Triggers:** 0
- **Slug:** `APITEMPLATE_IO`
- **Version:** 20261116_00

## Tools

### Create Image

**Slug:** `APITEMPLATE_IO_CREATE_IMAGE`

Generate JPEG and/or PNG images from a template and named object overrides. Generation consumes plan quota. The rate limit is 100 requests per 10 seconds per IP address; exceeding it returns HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | string | No | External reference ID included with the object in LIST_OBJECTS. |
| `overrides` | array | Yes | Template layer overrides. Each item requires a layer name and the properties to replace, such as text for a text layer or src for an image layer. Use APITEMPLATE_IO_LIST_TEMPLATES with with_layer_info=true to discover the layer names and available properties for the selected template. |
| `expiration` | integer | No | Generated image expiration in minutes; 0 stores it permanently. |
| `template_id` | string | Yes | ID of the image template to use for generation. |
| `cloud_storage` | integer ("0" | "1") | No | Whether to upload generated images to APITemplate.io CDN storage: 1 to upload, or 0 when a configured post action stores them elsewhere. |
| `output_image_type` | string ("all" | "jpegOnly" | "pngOnly") | No | Image formats to generate: both formats, JPEG only, or PNG only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create PDF

**Slug:** `APITEMPLATE_IO_CREATE_PDF`

Generate a synchronous PDF from template data. Generation consumes plan quota. The provider rate limit is 100 requests per 10 seconds per IP; exceeding it returns HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | JSON data object used to populate the template. |
| `filename` | string | No | Custom output filename ending in .pdf. |
| `expiration` | integer | No | Generated PDF expiration in minutes; 0 stores it permanently. |
| `output_html` | boolean | No | Whether to include an HTML output URL in the response. |
| `template_id` | string | Yes | ID of the template to use. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create PDF from HTML

**Slug:** `APITEMPLATE_IO_CREATE_PDF_FROM_HTML`

Create a PDF from HTML and optional dynamic data and styles. Generation consumes plan quota. The provider rate limit is 100 requests per 10 seconds per IP and excess requests return HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `css` | string | No | CSS styles, including the style tag. |
| `body` | string | Yes | HTML content used to generate the PDF. |
| `data` | object | No | Values for dynamic content in the HTML body. |
| `filename` | string | No | Custom output filename ending in .pdf. |
| `settings` | object | No | Official APITemplate.io settings accepted by the v2 PDF source APIs. |
| `expiration` | integer | No | Generated PDF expiration in minutes; 0 stores it permanently. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create PDF from Markdown

**Slug:** `APITEMPLATE_IO_CREATE_PDF_FROM_MARKDOWN`

Create a PDF from Markdown and optional dynamic data and styles. Generation consumes plan quota. The provider rate limit is 100 requests per 10 seconds per IP and excess requests return HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `css` | string | No | CSS styles, including the style tag. |
| `body` | string | Yes | Markdown content used to generate the PDF. |
| `data` | object | No | Values for dynamic content in the Markdown body. |
| `filename` | string | No | Custom output filename ending in .pdf. |
| `settings` | object | No | Official APITemplate.io settings accepted by the v2 PDF source APIs. |
| `expiration` | integer | No | Generated PDF expiration in minutes; 0 stores it permanently. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create PDF from URL

**Slug:** `APITEMPLATE_IO_CREATE_PDF_FROM_URL`

Create a PDF from a public URL. Generation consumes plan quota. The provider rate limit is 100 requests per 10 seconds per IP and excess requests return HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public URL of the page used to generate the PDF. |
| `filename` | string | No | Custom output filename ending in .pdf. |
| `settings` | object | No | Official APITemplate.io settings accepted by the v2 PDF source APIs. |
| `expiration` | integer | No | Generated PDF expiration in minutes; 0 stores it permanently. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Object

**Slug:** `APITEMPLATE_IO_DELETE_OBJECT`

Delete a generated PDF or image from the CDN and mark its transaction as deleted. The provider rate limit is 100 requests per 10 seconds per IP; exceeding it returns HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `transaction_ref` | string | Yes | Transaction reference of the object to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Information

**Slug:** `APITEMPLATE_IO_GET_ACCOUNT_INFORMATION`

Retrieve subscription, API quota, and template quota information for the authenticated account. The rate limit is 100 requests per 10 seconds per IP address; exceeding it returns HTTP 429.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template

**Slug:** `APITEMPLATE_IO_GET_TEMPLATE`

Retrieve an experimental PDF template's HTML, CSS, and serialized print settings. Contact APITemplate.io support for experimental API access. The rate limit is 100 requests per 10 seconds per IP address; exceeding it returns HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | ID of the PDF template to retrieve from Manage Templates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Objects

**Slug:** `APITEMPLATE_IO_LIST_OBJECTS`

List generated PDF and image objects. The provider rate limit is 100 requests per 10 seconds per IP; exceeding it returns HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of generated objects to return. |
| `offset` | integer | No | Number of generated objects to skip. |
| `template_id` | string | No | Filter by the template ID used to generate the object. |
| `transaction_ref` | string | No | Filter by transaction reference. |
| `transaction_type` | string ("PDF" | "JPEG" | "MERGE") | No | Filter by PDF, JPEG, or MERGE transaction type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Templates

**Slug:** `APITEMPLATE_IO_LIST_TEMPLATES`

List templates and their metadata. The provider rate limit is 100 requests per 10 seconds per IP; exceeding it returns HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of templates to return. |
| `format` | string ("PDF" | "JPEG") | No | Template format to return. |
| `offset` | integer | No | Number of templates to skip before returning results. |
| `group_name` | string | No | Return templates in this group. |
| `template_id` | string | No | Return the template with this template ID. |
| `with_layer_info` | boolean | No | Whether to include layer information for image templates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Merge PDFs

**Slug:** `APITEMPLATE_IO_MERGE_PDFS`

Merge PDF URLs into one PDF in the supplied order. Each request consumes plan quota. The API rate limit is 100 requests per 10 seconds per IP and returns HTTP 429 when exceeded.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urls` | array | Yes | Non-empty list of HTTP(S) or PDF data URLs to merge in order. |
| `expiration` | integer | No | Generated PDF expiration in minutes from 0 (permanent) through 43200 (30 days). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Template

**Slug:** `APITEMPLATE_IO_UPDATE_TEMPLATE`

Update an experimental PDF template's HTML, CSS, or custom header and footer settings. Contact APITemplate.io support for experimental API access. The provider rate limit is 100 requests per 10 seconds per IP; exceeding it returns HTTP 429.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `css` | string | No | Replacement template CSS. |
| `body` | string | No | Replacement HTML template body. |
| `settings` | object | No | Replacement custom header and footer settings. |
| `template_id` | string | Yes | ID of the PDF template to update from Manage Templates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
