> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to CraftMyPDF

The CraftMyPDF connector lets your AI agent act in each user's CraftMyPDF account. Each user connects their own CraftMyPDF API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 23 tools.

**Authentication:** API Key
**Categories:** Files & Documents
**Tools:** 23: 7 read, 15 write, 1 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=CRAFTMYPDF)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the CraftMyPDF connection

   In **AgentKit > Connections**, create a CraftMyPDF connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'craftmypdf'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize CraftMyPDF:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'craftmypdf_account_info_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "craftmypdf"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize CraftMyPDF:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="craftmypdf_account_info_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their CraftMyPDF credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'craftmypdf_account_info_get',
  toolInput: {},
  connector: 'craftmypdf',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="craftmypdf_account_info_get",
    tool_input={},
    connection_name="craftmypdf",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `craftmypdf_account_info_get`

Get Account Info · Read-only

Get your CraftMyPDF account information.
Returns the plan, credits used and remaining, and team details.
Use it to check remaining quota.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `craftmypdf_pdf_info_get`

Get PDF Info · Read-only

Get information about a PDF at a URL.
Returns its page count, page sizes and metadata.
The PDF must be publicly reachable.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): URL to a PDF file. Example: https://example.com/sample.pdf.

Example input: `{"url":"<url>"}`

### `craftmypdf_template_get`

Get Template · Read-only

Get a template's content, optionally at a specific version.
Returns its name, sample JSON data and body definition.
Use templates_list to find template IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): Template id. Example: ad577b2b22d4e612.
- `version` (`string`, optional): Version of the template. Leave it empty to use the latest version. Example: 0.

Example input: `{"template_id":"<template_id>"}`

### `craftmypdf_template_usage_get`

Get Template Usage · Read-only

Get how many PDFs and images were generated from templates over a date range.
Returns usage counts per template ID.
Dates are ISO 8601 in UTC.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_ids` (`string`, required): Comma-separated list of template IDs. Example: bba77b234e84443e,02077b2b1aa8b938.
- `end_date` (`string`, optional): End date in ISO 8601 format (UTC time). Example: 2025-01-30T11:59:59Z.
- `start_date` (`string`, optional): Start date in ISO 8601 format (UTC time). Example: 2025-01-30T00:00:00Z.

Example input: `{"template_ids":"<template_ids>"}`

### `craftmypdf_template_versions_list`

List Template Versions · Read-only

List all saved versions of a template.
Returns each version's number, timestamp and retained flag.
Pass a version to the create tools to use an older one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): Template ID. Example: 5ef77b2b187c968c.

Example input: `{"template_id":"<template_id>"}`

### `craftmypdf_templates_list`

List Templates · Read-only

List your templates, optionally by group, with paging.
Returns each template's id, name, group and last update time.
Use the template ID with the create tools.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_name` (`string`, optional): Filter templates in the same group(group_name). Example: Customer_009.
- `limit` (`integer`, optional): Retrieve only the number of records specified. Default to 300. Example: 300.
- `offset` (`integer`, optional): Offset is used to skip the number of records from the results. Default to 0. Example: 0.

Example input: `{}`

### `craftmypdf_transactions_list`

List Transactions · Read-only

List your generation transactions (each PDF or image created), newest first, with paging.
Returns each transaction's ref, template, pages, file URL and time.
Use it to audit usage.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Retrieve only the number of records specified. Default to 300. Example: 300.
- `offset` (`integer`, optional): Offset is used to skip the number of records from the results. Default to 0. Example: 0.

Example input: `{}`

### `craftmypdf_editor_session_create`

Create Editor Session · Write

Create an embeddable editor session for a template, with options for what the user can see and do.
Returns the editor URL to embed in an iframe and the session token UUID.
Use editor_session_deactivate to end it early.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `expiration` (`integer`, required): Expiration of the editor session in minutes. e.g. 1440=24 hours. Example: 1440.
- `template_id` (`string`, required): Template ID. Example: 5ef88b2b237c968c.
- `back_url` (`string`, optional): The URL for the back button. Example: https://yoururl.com.
- `can_create_pdf` (`boolean`, optional): Can Generate PDF. Default to true. Example: true.
- `can_edit_json` (`boolean`, optional): Can edit JSON. Default to true. Example: true.
- `can_preview` (`boolean`, optional): Can preview. Default to true. Example: true.
- `can_save` (`boolean`, optional): Can save the template. Default to true. Example: true.
- `can_show_back_url` (`boolean`, optional): Show Back button. Default to true. Example: true.
- `can_show_data` (`boolean`, optional): Show Data tab . Default to true. Example: true.
- `can_show_expression_doc` (`boolean`, optional): Show Expression Doc tab. Default to true. Example: true.
- `can_show_header` (`boolean`, optional): Show CraftMyPDF header. Default to true. Example: true.
- `can_show_help` (`boolean`, optional): Show Help tab. Default to true. Example: true.
- `can_show_layers` (`boolean`, optional): Show layer dialogue. Default to true. Example: true.
- `can_show_property_binding` (`boolean`, optional): Show Property Bind tab for element. Default to true. Example: true.
- `can_show_property_panel` (`boolean`, optional): Show property panel. Default to true. Example: true.
- `can_view_settings` (`boolean`, optional): Can view settings. Default to true. Example: true.
- `json_mode` (`integer`, optional): JSON editor - 1, JSON viewer - 2. Default to 1. Example: 1.

Example input: `{"expiration":1440,"template_id":"<template_id>"}`

### `craftmypdf_editor_session_deactivate`

Deactivate Editor Session · Write

End an editor session so its URL stops working.
Returns the result.
Pass the token UUID from editor_session_create.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `token_uuid` (`string`, required): Token UUID. Example: a1263472b-e5e3-4568-8654-ec49f48392.

Example input: `{"token_uuid":"<token_uuid>"}`

### `craftmypdf_image_create`

Create Image · Write

Generate a JPEG or PNG image from a template and JSON data.
Returns a JSON object with the image URL on CraftMyPDF's CDN.
Use pdf_create for a PDF.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `data` (`object`, required): Data to merge into the template, as a JSON object whose keys match the template's fields. Example: {"invoice_number": "INV38379", "date": "2026-01-15", "items": [{"name": "Consulting", "price": 1200}]}.
- `template_id` (`string`, required): Template ID. Example: 05f77b2b18ad809a.
- `cloud_storage` (`integer`, optional): Upload the generated PDFs/images to our storage CDN(Except export_type=file), default to 1. If you have configured Post Actions to upload the PDFs/Images to your own S3, please set it to 0. Example: 1.
- `expiration` (`integer`, optional): Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
- `load_data_from` (`string`, optional): Load data from an external URL. If this is specified, it will overwrite the data property. Example: https://api.example.com/invoices/38379.json.
- `output_file` (`string`, optional): output file, default to 'output.jpg'. Example: output.jpg.
- `output_type` (`string`, optional): image output file type, default to 'jpeg'. Options are 'jpeg' or 'png'. Example: jpeg.
- `postaction_s3_bucket` (`string`, optional): - This is to overwrite the AWS Bucket for Post Action(S3 Storage). Example: my-pdf-bucket.
- `postaction_s3_filekey` (`string`, optional): - This is to specify the file name for Post Action(S3 Storage). - Please do not specify the file extension - Please make sure the file name is unique - You might use slash (/) as the folder delimiter. Example: invoices/INV38379.
- `version` (`string`, optional): To generate an image using a specific version of the template. We use the latest template version unless you specify otherwise. Example: 8.

Example input: `{"data":{},"template_id":"<template_id>"}`

### `craftmypdf_pdf_create`

Create PDF · Write

Generate a PDF from a template and JSON data.
Returns a JSON object with the file URL on CraftMyPDF's CDN (valid for expiration minutes), the transaction ref and page count.
Use pdf_create_async for long documents and image_create for an image.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `data` (`object`, required): Data to merge into the template, as a JSON object whose keys match the template's fields. Example: {"invoice_number": "INV38379", "date": "2026-01-15", "items": [{"name": "Consulting", "price": 1200}]}.
- `template_id` (`string`, required): - Template ID. - You can specify a single template ID or multiple template IDs separated by commas. - If you specify multiple template IDs(e.g 05f77b2b18ad809a,81f338abcdd83d). The PDFs will be generated from multiple templates and the paging mode will be set to continuous. Example: 05f77b2b18ad809a.
- `cloud_storage` (`integer`, optional): Upload the generated PDFs/images to our storage CDN(Except export_type=file), default to 1. If you have configured Post Actions to upload the PDFs/Images to your own S3, please set it to 0. Example: 1.
- `expiration` (`integer`, optional): Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
- `image_resample_res` (`integer`, optional): Optimize/downsample images of current PDF to a resolution(in DPI). This helps to reduce the PDF file size. Suggested values are 1200, 600, 300, 150 or 72. Example: 600.
- `load_data_from` (`string`, optional): Load data from an external URL. If this is specified, it will overwrite the data property. Example: https://api.example.com/invoices/38379.json.
- `output_file` (`string`, optional): output file, default to 'output.pdf'. Example: output.pdf.
- `paging` (`string`, optional): This is for multiple templates. If multiple template ids are specified, this detemines the paging for the next PDF, either is 'continuous' or 'reset' . Default to 'continuous' - continuous : The expression {{sys.totalPages}} is the sum of the merged PDF and the {{sys.pageNumber}} continue from the last PDF page number. Example: reset.
- `password` (`string`, optional): if password_protected is enabled, please specify a password. Example: s3cret-pass.
- `password_protected` (`boolean`, optional): Enable password protection. Example: true.
- `pdf_version` (`string`, optional): - (Experimental) PDF version to generate. Supported versions are '1.4' and '1.7'. Defaults to 'Auto' which generates PDF 1.7. Example: 1.7. One of: `1.4`, `1.7`, `Auto`.
- `postaction_s3_bucket` (`string`, optional): - This is to overwrite the AWS Bucket for Post Action(S3 Storage). Example: my-pdf-bucket.
- `postaction_s3_filekey` (`string`, optional): This is to specify the file name for Post Action(S3 Storage). - Please do not specify the file extension - Please make sure the file name is unique - You might use slash (/) as the folder delimiter. Example: invoices/INV38379.
- `resize_format` (`string`, optional): - (Optional) If resize_images is set to 1, specify the format of the image. Either jpeg or png. Example: jpeg.
- `resize_images` (`boolean`, optional): - Resize all the images in the PDF to help reduce its size, especially if the template contains multiple or large images. - Either 1=true or 0=false. Default to '0' - If resize_images is set to 1, specify the resize_max_width, resize_max_height in pixels. - Images to be resized need to satisfy the following conditions: - The images with the content-type image/jpeg, image/jpg or image/png - The image URLs with the extension .jpg, .jpeg or .png. Example: false.
- `resize_max_height` (`integer`, optional): - If resize_images is set to 1, specify the maximum height in pixels for the images . Default to '1000'. Example: 1000.
- `resize_max_width` (`integer`, optional): - If resize_images is set to 1, specify the maximum width in pixels for the images. Default to '1000'. Example: 1000.
- `version` (`string`, optional): To generate a PDF using a specific version of the template. We use the latest template version unless you specify otherwise. Example: 8.

Example input: `{"data":{},"template_id":"<template_id>"}`

### `craftmypdf_pdf_create_async`

Create PDF Asynchronously · Write

Start generating a PDF from a template and JSON data without waiting.
Returns a transaction ref at once; CraftMyPDF calls webhook_url with the file URL when it is ready.
Use pdf_create when you can wait for the result.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `data` (`object`, required): Data to merge into the template, as a JSON object whose keys match the template's fields. Example: {"invoice_number": "INV38379", "date": "2026-01-15", "items": [{"name": "Consulting", "price": 1200}]}.
- `template_id` (`string`, required): Template ID. Example: 05f77b2b18ad809a.
- `cloud_storage` (`integer`, optional): Upload the generated PDFs/images to our storage CDN, default to 1. If you have configured Post Actions to upload the PDFs/Images to your own S3, please set it to 0. Example: 1.
- `expiration` (`integer`, optional): Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
- `image_resample_res` (`integer`, optional): Optimize/downsample images of current PDF to a resolution(in DPI). This helps to reduce the PDF file size. Suggested values are 1200, 600, 300, 150 or 72. Example: 600.
- `postaction_s3_bucket` (`string`, optional): - This is to overwrite the AWS Bucket for Post Action(S3 Storage). Example: my-pdf-bucket.
- `postaction_s3_filekey` (`string`, optional): - This is to specify the file name for Post Action(S3 Storage). - Please do not specify the file extension - Please make sure the file name is unique - You might use slash (/) as the folder delimiter. Example: invoices/INV38379.
- `resize_format` (`string`, optional): - (Optional) If resize_images is set to 1, specify the format of the image. Either jpeg or png. Example: jpeg.
- `resize_images` (`boolean`, optional): - Resize all the images in the PDF to help reduce its size, especially if the template contains multiple or large images. - Either 1=true or 0=false. Default to '0' - If resize_images is set to 1, specify the resize_max_width, resize_max_height in pixels. - Images to be resized need to satisfy the following conditions: - The images with the content-type image/jpeg, image/jpg or image/png - The image URLs with the extension .jpg, .jpeg or .png. Example: false.
- `resize_max_height` (`integer`, optional): - If resize_images is set to 1, specify the maximum height in pixels for the images . Default to '1000'. Example: 1000.
- `resize_max_width` (`integer`, optional): - If resize_images is set to 1, specify the maximum width in pixels for the images. Default to '1000'. Example: 1000.
- `version` (`string`, optional): To generate a PDF using a specific version of the template. We use the latest template version unless you specify otherwise. Example: 8.
- `webhook_url` (`string`, optional): Callback URL to your server. Example: https://myserver.com/pdfhandler.

Example input: `{"data":{},"template_id":"<template_id>"}`

### `craftmypdf_pdf_create_merged`

Create Merged PDF from Templates · Write

Generate one PDF from several templates, each with its own data, merged in order.
Returns a JSON object with the merged file URL.
Use pdf_create for a single template.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `templates` (`array`, required): Array of template ids and JSON data. Example: [{"template_id": "96177b2b1ac483b0", "data": {"invoice_number": "INV0001", "date": "2021-09-30", "currency": "USD", "total_amount": 82542.56}}, {"template_id...
- `cloud_storage` (`integer`, optional): Upload the generated PDFs/images to our storage CDN, default to 1. If you have configured Post Actions to upload the PDFs/Images to your own S3, please set it to 0. Example: 1.
- `data` (`object`, optional): Data to merge into the template, as a JSON object whose keys match the template's fields. Example: {"invoice_number": "INV38379", "date": "2026-01-15", "items": [{"name": "Consulting", "price": 1200}]}.
- `expiration` (`integer`, optional): Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
- `image_resample_res` (`integer`, optional): Optimize/downsample images of current PDF to a resolution(in DPI). This helps to reduce the PDF file size. Suggested values are 1200, 600, 300, 150 or 72. Example: 600.
- `output_file` (`string`, optional): output file, default to 'output.pdf'. Example: output.pdf.
- `paging` (`string`, optional): It detemines the paging for the next PDF, either is 'continuous' or 'reset' . Default to 'reset' - continuous : The expression {{sys.totalPages}} is the sum of the merged PDF and the {{sys.pageNumber}} continue from the last PDF page number. - reset: The expression {{sys.totalPages}} is the total pages of current PDF and the {{sys.pageNumber}} auto-reset to zero in the next PDF. Example: reset.
- `postaction_s3_bucket` (`string`, optional): - This is to overwrite the AWS Bucket for Post Action(S3 Storage). Example: my-pdf-bucket.
- `postaction_s3_filekey` (`string`, optional): - This is to specify the file name for Post Action(S3 Storage). - Please do not specify the file extension - Please make sure the file name is unique - You might use slash (/) as the folder delimiter. Example: invoices/INV38379.
- `resize_format` (`string`, optional): - (Optional) If resize_images is set to 1, specify the format of the image. Either jpeg or png. Example: jpeg.
- `resize_images` (`boolean`, optional): - Resize all the images in the PDF to help reduce its size, especially if the template contains multiple or large images. - Either 1=true or 0=false. Default to '0' - If resize_images is set to 1, specify the resize_max_width, resize_max_height in pixels. - Images to be resized need to satisfy the following conditions: - The images with the content-type image/jpeg, image/jpg or image/png - The image URLs with the extension .jpg, .jpeg or .png. Example: false.
- `resize_max_height` (`integer`, optional): - If resize_images is set to 1, specify the maximum height in pixels for the images . Default to '1000'. Example: 1000.
- `resize_max_width` (`integer`, optional): - If resize_images is set to 1, specify the maximum width in pixels for the images. Default to '1000'. Example: 1000.

Example input: `{"templates":[]}`

### `craftmypdf_pdf_fields_update`

Fill PDF Form Fields · Write

Fill the fillable fields (text fields, checkboxes, dropdowns) of an existing PDF.
Returns a JSON object with the filled file URL.
Field IDs can be found with CraftMyPDF's fillable field reader tool.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `fields` (`array`, required): Fields to fill. Each has the field id and the value to set, plus optional readOnly and fontSize. Example: [{"id": "last_name", "value": "Smith"}].
- `url` (`string`, required): The URL of the PDF file to update. Example: https://craftmypdf.s3.ap-southeast-1.amazonaws.com/test/output+-+2025-01-24T170834.623.pdf.
- `cloud_storage` (`integer`, optional): Upload the generated PDFs/images to our storage CDN, default to 1. If you have configured Post Actions to upload the PDFs/Images to your own S3, please set it to 0. Example: 1.
- `expiration` (`integer`, optional): Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
- `output_file` (`string`, optional): output file, default to 'output.pdf'. Example: output.pdf.

Example input: `{"fields":[{"id":"last_name","value":"Smith"}],"url":"<url>"}`

### `craftmypdf_pdf_text_add`

Add Text to PDF · Write

Stamp text (such as page numbers or a footer) onto pages of an existing PDF.
Returns a JSON object with the new file URL.
Use {{pageNumber}} and {{totalPages}} placeholders in the text.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `text_settings` (`array`, required): Text annotations to add. Each needs page_selector (such as 1 or 2-*), the text and a position (top-left, top-center, top-right, middle-left, center, middle-right, bottom-left, bottom-center or bottom-right); offset_x, offset_y, font_size, hex_color, font_family, opacity and rotation are optional. Example: [{"page_selector": "1-*", "text": "Page {{pageNumber}} of {{totalPages}}", "position": "bottom-center", "font_size": 10}].
- `url` (`string`, required): The URL of the PDF file to be annotated. Example: https://example.com/sample.pdf.
- `cloud_storage` (`integer`, optional): Upload the generated PDFs/images to our storage CDN, default to 1. If you have configured Post Actions to upload the PDFs/Images to your own S3, please set it to 0. Example: 1.
- `expiration` (`integer`, optional): Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
- `output_file` (`string`, optional): output file, default to 'output.pdf'. Example: output.pdf.

Example input: `{"text_settings":[{"page_selector":"1-*","text":"Page {{pageNumber}} of {{totalPages}}","position":"bottom-center","font_size":10}],"url":"<url>"}`

### `craftmypdf_pdf_watermark_add`

Add Watermark to PDF · Write

Add a diagonal text watermark to every page of a PDF.
Returns a JSON object with the watermarked file URL.
Use pdf_text_add for more control over position and pages.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `text` (`string`, required): Watermark text. Example: Confidential.
- `url` (`string`, required): URL of the source PDF. Example: https://fileserver.com/sample.pdf.
- `cloud_storage` (`integer`, optional): Upload the generated PDFs/images to our storage CDN, default to 1. If you have configured Post Actions to upload the PDFs/Images to your own S3, please set it to 0. Example: 1.
- `expiration` (`integer`, optional): Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
- `font_family` (`string`, optional): Font family of the watermark. Default to Helvetica. Available fonts are: Courier, Courier-Bold, Courier-Oblique, Courier-BoldOblique, Helvetica, Helvetica-Bold, Helvetica-Oblique, Helvetica-BoldOblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic, Symbol, ZapfDingbats,. Example: Helvetica.
- `font_size` (`integer`, optional): Font size of the watermark, default to 40. Example: 40.
- `hex_color` (`string`, optional): Color of the watermark, it has to be a hex color and starts with '#', default to '#c7c7c7'. Example: #c7c7c7.
- `opacity` (`number`, optional): Opacity of the watermark, default to 0.5. Example: 0.5.
- `output_file` (`string`, optional): output file, default to 'output.pdf'. Example: output.pdf.
- `postaction_s3_bucket` (`string`, optional): - This is to overwrite the AWS Bucket for Post Action(S3 Storage). Example: my-pdf-bucket.
- `postaction_s3_filekey` (`string`, optional): - This is to specify the file name for Post Action(S3 Storage). - Please do not specify the file extension - Please make sure the file name is unique - You might use slash (/) as the folder delimiter. Example: invoices/INV38379.
- `rotation` (`integer`, optional): Rotation of the watermark, default to 45. Example: 45.

Example input: `{"text":"<text>","url":"<url>"}`

### `craftmypdf_pdfs_create_parallel`

Create PDFs in Parallel · Write

Generate several PDFs in one call, each request taking the same fields as pdf_create, optionally merged into one file.
Returns the file URL of each PDF (and of the merged PDF when merge is true).
Use it for batches.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `requests` (`array`, required): Array of requests, please look at /v1/create for the detailed parameters. Example: [{"data": {"title": "Welcome to CraftMyPDF1!", "report_date": "2021-12-13 12:30"}, "template_id": "be277b2b12cebfa0", "meta": "yourrefernce0001"}, {"data": {...
- `merge` (`boolean`, optional): Whether to merge all generated PDFs into a single PDF. Default to false. Example: true.
- `merge_expiration` (`integer`, optional): Expiration of the merged PDF in minutes. Only applicable when merge is true. Default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 5.

Example input: `{"requests":[]}`

### `craftmypdf_pdfs_merge`

Merge PDFs · Write

Merge PDFs from a list of URLs into one PDF.
Returns a JSON object with the merged file URL.
The source PDFs must be publicly reachable.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `urls` (`array`, required): URL array. Example: ["https://example.com/a.pdf", "https://example.com/b.pdf"]
- `cloud_storage` (`integer`, optional): Upload the generated PDFs/images to our storage CDN, default to 1. If you have configured Post Actions to upload the PDFs/Images to your own S3, please set it to 0. Example: 1.
- `expiration` (`integer`, optional): Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
- `output_file` (`string`, optional): output file, default to 'output.pdf'. Example: output.pdf.
- `postaction_s3_bucket` (`string`, optional): - This is to overwrite the AWS Bucket for Post Action(S3 Storage). Example: my-pdf-bucket.
- `postaction_s3_filekey` (`string`, optional): - This is to specify the file name for Post Action(S3 Storage). - Please do not specify the file extension - Please make sure the file name is unique - You might use slash (/) as the folder delimiter. Example: invoices/INV38379.

Example input: `{"urls":["https://example.com/a.pdf","https://example.com/b.pdf"]}`

### `craftmypdf_template_create_from`

Create Template from Existing · Write

Create a new template by copying an existing one (optionally a specific version).
Returns the new template's id.
Use template_update to rename it or change its sample data.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `template_id` (`string`, required): Template ID Note: When using a team API Key to clone a template from another team, make sure that: - The creator of the template and the owner of the team API Key are the same person. - The owner of the team where the template belongs and the owner of the team API Key are the same. Example: 5ef88b2b237c968c.
- `group_name` (`string`, optional): Group name of the tempate, default to null. It's used for grouping templates of the same category(or customer) and it can be used with list-templates API to retrieve templates in the same group. Example: Customer_009.
- `name` (`string`, optional): Name of the new template. Example: My Invoice.
- `version` (`string`, optional): Version of the template. Leave it empty to use the latest version. Example: 8.

Example input: `{"template_id":"<template_id>"}`

### `craftmypdf_template_transfer`

Transfer Template · Write

Move a template to another team in your CraftMyPDF account.
Returns the result.
The template leaves the current team.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `team_id` (`string`, required): The team id. Example: haag3ce4.
- `template_id` (`string`, required): Template ID. Example: 5ef88b2b237c968c.

Example input: `{"team_id":"<team_id>","template_id":"<template_id>"}`

### `craftmypdf_template_update`

Update Template · Write

Update a template's name or sample JSON data.
Returns the result.
The template body (layout) can only be edited in the CraftMyPDF editor.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): Template ID. Example: 05f77b2b18ad809a.
- `json` (`string`, optional): Optional, sample JSON data for the template. Example: {"invoice_number": "INV38379"}
- `name` (`string`, optional): Optional, name of the template. Example: My Template.

Example input: `{"template_id":"<template_id>"}`

### `craftmypdf_template_versions_retain`

Retain Template Versions · Write

Mark template versions as retained (protected from automatic cleanup) or not.
Returns the result.
Use template_versions_list to see version numbers.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `keep` (`boolean`, required): Whether to keep (true) or not keep (false) the specified versions. Example: true.
- `template_id` (`string`, required): Template ID. Example: c2d77b234151b7c4.
- `versions` (`array`, required): Array of version numbers to retain or not retain. Example: [1, 4]

Example input: `{"keep":true,"template_id":"<template_id>","versions":[1,4]}`

### `craftmypdf_template_delete`

Delete Template · Destructive

Delete a template.
Returns the result.
This cannot be undone; generated PDFs are not affected.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): Template ID. Example: 5ef88b2b237c968c.

Example input: `{"template_id":"<template_id>"}`

## Related

Other Files & Documents connectors ([all 76](/agentkit/connectors/?category=files-documents)):

- [Notion](/agentkit/connectors/notion/): Scalekit connector, OAuth, 51 tools
- [Google Sheets](/agentkit/connectors/googlesheets/): Scalekit connector, OAuth, 48 tools
- [Google Drive](/agentkit/connectors/googledrive/): Scalekit connector, OAuth, 47 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
