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.
- Tools
- 23
- What they doRead · write · destructive
- 7 · 15 · 17 read15 write1 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the CraftMyPDF connection
In AgentKit > Connections, create a CraftMyPDF connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 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.actionsconst connector = 'craftmypdf'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'craftmypdf_account_info_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "craftmypdf"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="craftmypdf_account_info_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their CraftMyPDF credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolcraftmypdf_account_info_getGet your CraftMyPDF account information.Read-onlyGet Account Info
Get your CraftMyPDF account information. Returns the plan, credits used and remaining, and team details. Use it to check remaining quota.
Inputs
This tool takes no inputs.
craftmypdf_pdf_info_getGet information about a PDF at a URL.Read-onlyGet PDF Info
Get information about a PDF at a URL. Returns its page count, page sizes and metadata. The PDF must be publicly reachable.
Inputs
urlstringrequired- URL to a PDF file. Example: https://example.com/sample.pdf.
craftmypdf_template_getGet a template's content, optionally at a specific version.Read-onlyGet Template
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.
Inputs
template_idstringrequired- Template id. Example: ad577b2b22d4e612.
versionstring- Version of the template. Leave it empty to use the latest version. Example: 0.
craftmypdf_template_usage_getGet how many PDFs and images were generated from templates over a date range.Read-onlyGet Template Usage
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.
Inputs
template_idsstringrequired- Comma-separated list of template IDs. Example: bba77b234e84443e,02077b2b1aa8b938.
end_datestring- End date in ISO 8601 format (UTC time). Example: 2025-01-30T11:59:59Z.
start_datestring- Start date in ISO 8601 format (UTC time). Example: 2025-01-30T00:00:00Z.
craftmypdf_template_versions_listList all saved versions of a template.Read-onlyList Template Versions
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.
Inputs
template_idstringrequired- Template ID. Example: 5ef77b2b187c968c.
craftmypdf_templates_listList your templates, optionally by group, with paging.Read-onlyList Templates
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.
Inputs
group_namestring- Filter templates in the same group(group_name). Example: Customer_009.
limitinteger- Retrieve only the number of records specified. Default to 300. Example: 300.
offsetinteger- Offset is used to skip the number of records from the results. Default to 0. Example: 0.
craftmypdf_transactions_listList your generation transactions (each PDF or image created), newest first, with paging.Read-onlyList Transactions
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.
Inputs
limitinteger- Retrieve only the number of records specified. Default to 300. Example: 300.
offsetinteger- Offset is used to skip the number of records from the results. Default to 0. Example: 0.
craftmypdf_editor_session_createCreate an embeddable editor session for a template, with options for what the user can see and do.WriteCreate Editor Session
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.
Inputs
expirationintegerrequired- Expiration of the editor session in minutes. e.g. 1440=24 hours. Example: 1440.
template_idstringrequired- Template ID. Example: 5ef88b2b237c968c.
back_urlstring- The URL for the back button. Example: https://yoururl.com.
can_create_pdfboolean- Can Generate PDF. Default to true. Example: true.
can_edit_jsonboolean- Can edit JSON. Default to true. Example: true.
can_previewboolean- Can preview. Default to true. Example: true.
can_saveboolean- Can save the template. Default to true. Example: true.
can_show_back_urlboolean- Show Back button. Default to true. Example: true.
can_show_databoolean- Show Data tab . Default to true. Example: true.
can_show_expression_docboolean- Show Expression Doc tab. Default to true. Example: true.
can_show_headerboolean- Show CraftMyPDF header. Default to true. Example: true.
can_show_helpboolean- Show Help tab. Default to true. Example: true.
can_show_layersboolean- Show layer dialogue. Default to true. Example: true.
can_show_property_bindingboolean- Show Property Bind tab for element. Default to true. Example: true.
can_show_property_panelboolean- Show property panel. Default to true. Example: true.
can_view_settingsboolean- Can view settings. Default to true. Example: true.
json_modeinteger- JSON editor - 1, JSON viewer - 2. Default to 1. Example: 1.
craftmypdf_editor_session_deactivateEnd an editor session so its URL stops working.WriteDeactivate Editor Session
End an editor session so its URL stops working. Returns the result. Pass the token UUID from editor_session_create.
- Idempotent
Inputs
token_uuidstringrequired- Token UUID. Example: a1263472b-e5e3-4568-8654-ec49f48392.
craftmypdf_image_createGenerate a JPEG or PNG image from a template and JSON data.WriteCreate Image
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.
Inputs
dataobjectrequired- 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_idstringrequired- Template ID. Example: 05f77b2b18ad809a.
cloud_storageinteger- 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.
expirationinteger- Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
load_data_fromstring- 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_filestring- output file, default to 'output.jpg'. Example: output.jpg.
output_typestring- image output file type, default to 'jpeg'. Options are 'jpeg' or 'png'. Example: jpeg.
postaction_s3_bucketstring- - This is to overwrite the AWS Bucket for Post Action(S3 Storage). Example: my-pdf-bucket.
postaction_s3_filekeystring- - 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.
versionstring- To generate an image using a specific version of the template. We use the latest template version unless you specify otherwise. Example: 8.
craftmypdf_pdf_createGenerate a PDF from a template and JSON data.WriteCreate PDF
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.
Inputs
dataobjectrequired- 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_idstringrequired- - 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_storageinteger- 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.
expirationinteger- Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
image_resample_resinteger- 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_fromstring- 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_filestring- output file, default to 'output.pdf'. Example: output.pdf.
pagingstring- 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.
passwordstring- if password_protected is enabled, please specify a password. Example: s3cret-pass.
password_protectedboolean- Enable password protection. Example: true.
pdf_versionstring- - (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.41.7Auto postaction_s3_bucketstring- - This is to overwrite the AWS Bucket for Post Action(S3 Storage). Example: my-pdf-bucket.
postaction_s3_filekeystring- 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_formatstring- - (Optional) If resize_images is set to 1, specify the format of the image. Either jpeg or png. Example: jpeg.
resize_imagesboolean- - 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_heightinteger- - If resize_images is set to 1, specify the maximum height in pixels for the images . Default to '1000'. Example: 1000.
resize_max_widthinteger- - If resize_images is set to 1, specify the maximum width in pixels for the images. Default to '1000'. Example: 1000.
versionstring- To generate a PDF using a specific version of the template. We use the latest template version unless you specify otherwise. Example: 8.
craftmypdf_pdf_create_asyncStart generating a PDF from a template and JSON data without waiting.WriteCreate PDF Asynchronously
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.
Inputs
dataobjectrequired- 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_idstringrequired- Template ID. Example: 05f77b2b18ad809a.
cloud_storageinteger- 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.
expirationinteger- Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
image_resample_resinteger- 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_bucketstring- - This is to overwrite the AWS Bucket for Post Action(S3 Storage). Example: my-pdf-bucket.
postaction_s3_filekeystring- - 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_formatstring- - (Optional) If resize_images is set to 1, specify the format of the image. Either jpeg or png. Example: jpeg.
resize_imagesboolean- - 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_heightinteger- - If resize_images is set to 1, specify the maximum height in pixels for the images . Default to '1000'. Example: 1000.
resize_max_widthinteger- - If resize_images is set to 1, specify the maximum width in pixels for the images. Default to '1000'. Example: 1000.
versionstring- To generate a PDF using a specific version of the template. We use the latest template version unless you specify otherwise. Example: 8.
webhook_urlstring- Callback URL to your server. Example: https://myserver.com/pdfhandler.
craftmypdf_pdf_create_mergedGenerate one PDF from several templates, each with its own data, merged in order.WriteCreate Merged PDF from Templates
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.
Inputs
templatesarrayrequired- 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_storageinteger- 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.
dataobject- 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}]}.
expirationinteger- Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
image_resample_resinteger- 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_filestring- output file, default to 'output.pdf'. Example: output.pdf.
pagingstring- 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_bucketstring- - This is to overwrite the AWS Bucket for Post Action(S3 Storage). Example: my-pdf-bucket.
postaction_s3_filekeystring- - 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_formatstring- - (Optional) If resize_images is set to 1, specify the format of the image. Either jpeg or png. Example: jpeg.
resize_imagesboolean- - 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_heightinteger- - If resize_images is set to 1, specify the maximum height in pixels for the images . Default to '1000'. Example: 1000.
resize_max_widthinteger- - If resize_images is set to 1, specify the maximum width in pixels for the images. Default to '1000'. Example: 1000.
craftmypdf_pdf_fields_updateFill the fillable fields (text fields, checkboxes, dropdowns) of an existing PDF.WriteFill PDF Form Fields
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.
Inputs
fieldsarrayrequired- Fields to fill. Each has the field id and the value to set, plus optional readOnly and fontSize. Example: [{"id": "last_name", "value": "Smith"}].
urlstringrequired- 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_storageinteger- 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.
expirationinteger- Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
output_filestring- output file, default to 'output.pdf'. Example: output.pdf.
craftmypdf_pdf_text_addStamp text (such as page numbers or a footer) onto pages of an existing PDF.WriteAdd Text to PDF
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.
Inputs
text_settingsarrayrequired- 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}].
urlstringrequired- The URL of the PDF file to be annotated. Example: https://example.com/sample.pdf.
cloud_storageinteger- 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.
expirationinteger- Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
output_filestring- output file, default to 'output.pdf'. Example: output.pdf.
craftmypdf_pdf_watermark_addAdd a diagonal text watermark to every page of a PDF.WriteAdd Watermark to PDF
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.
Inputs
textstringrequired- Watermark text. Example: Confidential.
urlstringrequired- URL of the source PDF. Example: https://fileserver.com/sample.pdf.
cloud_storageinteger- 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.
expirationinteger- Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
font_familystring- 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_sizeinteger- Font size of the watermark, default to 40. Example: 40.
hex_colorstring- Color of the watermark, it has to be a hex color and starts with '#', default to '#c7c7c7'. Example: #c7c7c7.
opacitynumber- Opacity of the watermark, default to 0.5. Example: 0.5.
output_filestring- output file, default to 'output.pdf'. Example: output.pdf.
postaction_s3_bucketstring- - This is to overwrite the AWS Bucket for Post Action(S3 Storage). Example: my-pdf-bucket.
postaction_s3_filekeystring- - 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.
rotationinteger- Rotation of the watermark, default to 45. Example: 45.
craftmypdf_pdfs_create_parallelGenerate several PDFs in one call, each request taking the same fields as pdf_create, optionally merged into one file.WriteCreate PDFs in Parallel
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.
Inputs
requestsarrayrequired- 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": {...
mergeboolean- Whether to merge all generated PDFs into a single PDF. Default to false. Example: true.
merge_expirationinteger- 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.
craftmypdf_pdfs_mergeMerge PDFs from a list of URLs into one PDF.WriteMerge PDFs
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.
Inputs
urlsarrayrequired- URL array. Example: ["https://example.com/a.pdf", "https://example.com/b.pdf"]
cloud_storageinteger- 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.
expirationinteger- Expiration of the generated PDF in minutes. default to 5 minutes, range between 1 minute and 10080 minutes(7 days). Example: 60.
output_filestring- output file, default to 'output.pdf'. Example: output.pdf.
postaction_s3_bucketstring- - This is to overwrite the AWS Bucket for Post Action(S3 Storage). Example: my-pdf-bucket.
postaction_s3_filekeystring- - 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.
craftmypdf_template_create_fromCreate a new template by copying an existing one (optionally a specific version).WriteCreate Template from Existing
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.
Inputs
template_idstringrequired- 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_namestring- 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.
namestring- Name of the new template. Example: My Invoice.
versionstring- Version of the template. Leave it empty to use the latest version. Example: 8.
craftmypdf_template_transferMove a template to another team in your CraftMyPDF account.WriteTransfer Template
Move a template to another team in your CraftMyPDF account. Returns the result. The template leaves the current team.
Inputs
team_idstringrequired- The team id. Example: haag3ce4.
template_idstringrequired- Template ID. Example: 5ef88b2b237c968c.
craftmypdf_template_updateUpdate a template's name or sample JSON data.WriteUpdate Template
Update a template's name or sample JSON data. Returns the result. The template body (layout) can only be edited in the CraftMyPDF editor.
- Idempotent
Inputs
template_idstringrequired- Template ID. Example: 05f77b2b18ad809a.
jsonstring- Optional, sample JSON data for the template. Example: {"invoice_number": "INV38379"}
namestring- Optional, name of the template. Example: My Template.
craftmypdf_template_versions_retainMark template versions as retained (protected from automatic cleanup) or not.WriteRetain Template Versions
Mark template versions as retained (protected from automatic cleanup) or not. Returns the result. Use template_versions_list to see version numbers.
- Idempotent
Inputs
keepbooleanrequired- Whether to keep (true) or not keep (false) the specified versions. Example: true.
template_idstringrequired- Template ID. Example: c2d77b234151b7c4.
versionsarrayrequired- Array of version numbers to retain or not retain. Example: [1, 4]
craftmypdf_template_deleteDelete a template.DestructiveDelete Template
Delete a template. Returns the result. This cannot be undone; generated PDFs are not affected.
- Idempotent
Inputs
template_idstringrequired- Template ID. Example: 5ef88b2b237c968c.
No tools match.