Skip to main content
TemplateFox logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 24
  • Triggers: 0
  • Slug: TEMPLATEFOX
  • Version: 20261101_00

Tools

Slug: TEMPLATEFOX_CREATE_AGENT_TEMPLATEQueue TemplateFox’s authoring agent to create an image template from natural-language instructions. This creates account data and costs 25 credits when queued; TemplateFox refunds the credits if the job fails.

Input Parameters

string
required
Name for the new image template (1-100 characters).
object
Optional nested brand guidance for colors, fonts, and public assets.
integer
Custom width in pixels (16-8000). Requires height and cannot accompany preset.
integer
Custom height in pixels (16-8000). Requires width and cannot accompany preset.
string ("instagram-square" | "instagram-story" | "og-image" | "twitter-card" | "pinterest-pin" | "square-512")
Standard output size. Provide this or both width and height, never both sizing methods.
string
required
Detailed natural-language design instructions (10-4000 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_CREATE_IMAGEGenerate a PNG, JPEG, or WebP image from a TemplateFox image template and return a temporary URL or configured S3 location. This consumes 1 credit on success; failed rendering is documented as refunded. Binary output is not exposed.

Input Parameters

object
Template variables keyed by the template’s declared fields.
integer
Output width in pixels (100-4000); height preserves aspect ratio.
string ("png" | "jpeg" | "webp")
Output image format.
integer
JPEG or WebP quality from 1-100; ignored for PNG.
string
Optional template version tag or number (max 50 characters).
string
Output filename using only letters, digits, underscore, period, and hyphen (max 100 characters).
boolean
Store the image in configured S3-compatible storage instead of only returning a temporary URL. This is documented as Business-plan functionality.
string
Optional valid lowercase S3 bucket override when store_s3 is true.
integer
Temporary URL lifetime in seconds (60-604800).
string
Optional S3 object path when store_s3 is true (max 500 characters).
string
required
Exactly 12-character ID of the image template.
array
Up to 100 layer edits. Use LIST_TEMPLATE_LAYERS to discover layer names and modifiable properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_CREATE_PDFGenerate a PDF synchronously from a TemplateFox template and return a temporary URL or configured S3 location. A successful generation consumes 1 credit; TemplateFox documents failed rendering as refunded. Binary output is intentionally not exposed.

Input Parameters

object
required
Template variables keyed by fields declared on the template. Use LIST_TEMPLATE_FIELDS to discover the accepted fields.
string
Optional template version tag or number (maximum 50 characters).
string
Output filename without .pdf; use only letters, digits, underscores, periods, and hyphens (maximum 100 characters).
boolean
Store the PDF in configured S3-compatible storage instead of returning a temporary URL. This is documented as Business-plan functionality.
string
Lowercase destination bucket override when store_s3 is true. It must be a valid S3 bucket name.
integer
Temporary URL lifetime in seconds (60-604800).
string ("pdf/a-1b" | "pdf/a-2b" | "pdf/a-3b")
Optional archival PDF conformance variant.
string
Destination object path when store_s3 is true; use only letters, digits, underscores, periods, slashes, and hyphens.
string
required
Exactly 12-character ID of the PDF template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_CREATE_PDF_ASYNCQueue PDF generation and return a job ID for polling. This charges 1 credit when queued and is documented to refund permanently failed jobs; webhook delivery is optional.

Input Parameters

object
required
Template variables keyed by the fields declared on the template.
string
Optional template version tag or number (max 50 characters).
string
Output filename without .pdf (max 100 characters).
boolean
Store the result in configured S3-compatible storage; documented as Business-plan functionality.
string
Optional valid lowercase S3 bucket override when store_s3 is true.
integer
Result URL lifetime in seconds (60-604800).
string ("pdf/a-1b" | "pdf/a-2b" | "pdf/a-3b")
Optional archival PDF conformance variant.
string
Optional S3 object path when store_s3 is true (max 500 characters).
string
required
Exactly 12-character ID of the PDF template.
string
Public HTTPS callback URL for job completion (max 2083 characters).
string
Secret used to HMAC-SHA256-sign webhook delivery; only valid with webhook_url. Treat this value as sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_CREATE_TEMPLATE_VERSIONCreate an immutable snapshot of an existing TemplateFox template with a unique lowercase tag.

Input Parameters

string
required
Unique lowercase version tag. Use letters or digits at both ends and only lowercase letters, digits, underscores, or hyphens inside.
string
Optional description of this immutable template snapshot.
string
required
Exactly 12-character ID of the template to snapshot.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_DELETE_S3_CONFIGPermanently remove the connected account’s saved S3-compatible storage credentials. This destructive operation disables future S3 uploads and cannot be undone. S3 integration is documented as Business-plan functionality, and successful deletion was not live-verified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_DELETE_TEMPLATE_VERSIONPermanently delete one immutable template version. This is destructive and cannot be undone.

Input Parameters

string
required
Exactly 12-character ID of the template whose version to delete.
integer
required
Positive version number to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_EXTRACT_PDF_PAGESExtract, reorder, or split selected pages from one PDF and return a temporary result URL. Successful extraction consumes 1 TemplateFox credit.

Input Parameters

string
required
1-indexed page singles and ranges in the desired output order, for example ‘1-3, 5, 7-9’.
string
Public HTTPS URL of the source PDF. Provide exactly one PDF source: pdf_url or pdf_base64.
string
Result filename without .pdf (maximum 100 characters).
integer
Result URL lifetime in seconds (60-604800).
string
Base64-encoded source PDF. Provide exactly one PDF source: pdf_base64 or pdf_url.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_GET_ACCOUNTGet the connected TemplateFox account identity and remaining credit balance without consuming credits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_GET_AGENT_JOBGet an authoring-agent job’s status, resulting template ID, preview, charged credits, or failure details. Tier availability is unknown.

Input Parameters

string
required
UUID returned by CREATE_AGENT_TEMPLATE or REVISE_AGENT_TEMPLATE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_GET_PDF_JOBGet the status, result location, or failure details of an asynchronous PDF generation job.

Input Parameters

string
required
UUID returned by CREATE_PDF_ASYNC.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_GET_S3_CONFIGGet the connected account’s S3-compatible storage configuration. S3 upload is documented as Business-plan functionality. The returned secret access key is masked and is not usable credential material.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_LIST_ACCOUNT_TRANSACTIONSList credit purchases, consumption, refunds, and bonuses one offset page at a time. Positive credit values mean credits consumed; negative values mean credits added.

Input Parameters

integer
Maximum transactions to return on this page (1-1000).
integer
Zero-based result offset. Increase it by the number of returned transactions to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_LIST_PDF_JOBSList asynchronous PDF generation jobs, optionally filtered by status, one offset page at a time.

Input Parameters

integer
Maximum jobs to return on this page (1-100).
integer
Zero-based result offset. Increase it by the number of returned jobs to fetch the next page.
string ("pending" | "processing" | "completed" | "failed")
Only return jobs in this state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_LIST_TEMPLATE_FIELDSList the dynamic variables a template accepts so an agent can construct valid generation data.

Input Parameters

string
required
Exactly 12-character template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_LIST_TEMPLATE_LAYERSList addressable image-template layers and their modifiable properties for CREATE_IMAGE.

Input Parameters

string
required
Exactly 12-character image template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_LIST_TEMPLATESList PDF or image templates belonging to the connected TemplateFox team.

Input Parameters

string ("pdf" | "image")
Only return templates of this kind.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_LIST_TEMPLATE_VERSIONSList immutable snapshots of a template, including version numbers and optional tags.

Input Parameters

string
required
Exactly 12-character ID of the template whose versions to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_MERGE_PDFSConcatenate two or more PDFs in the supplied order and return a temporary result URL. Each successful merge consumes 1 TemplateFox credit.

Input Parameters

array
required
PDFs to concatenate in order; each item must contain exactly one source.
string
Result filename without .pdf (maximum 100 characters).
integer
Result URL lifetime in seconds (60-604800).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_REVISE_AGENT_TEMPLATEQueue TemplateFox’s authoring agent to revise an existing image template from feedback. This irreversibly mutates account content and costs 10 credits when queued; TemplateFox refunds the credits if the job fails. Use a template ID returned by the list-templates tool because TemplateFox may return a server error when it cannot verify template access.

Input Parameters

object
Optional nested brand guidance for the revision.
string
required
Natural-language revision request (5-4000 characters).
string
required
Exactly 12-character ID of an existing account-owned image template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_ROTATE_PDFRotate all pages or selected pages in a PDF and return a temporary result URL. Each successful rotation consumes 1 TemplateFox credit.

Input Parameters

string
Public HTTPS URL of the source PDF; provide exactly one source field.
string
Result filename without .pdf (maximum 100 characters).
integer ("0" | "90" | "180" | "270")
Clockwise rotation applied to every page. Provide exactly one of rotation or page_rotations; 0 counts as provided.
integer
Result URL lifetime in seconds (60-604800).
string
Base64-encoded source PDF; provide exactly one source field.
object
Map of positive 1-indexed page-number strings to clockwise rotations of 0, 90, 180, or 270. Mutually exclusive with rotation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_SAVE_S3_CONFIGCreate or update the connected account’s S3-compatible storage credentials, then test access to the configured bucket. This sensitive Business-plan operation persists third-party credentials in TemplateFox. If validation fails, the credentials remain saved; credential values are never returned.

Input Parameters

string
required
Lowercase S3 bucket name (3-63 characters). Use only letters, digits, periods, and hyphens; it must not resemble an IP address.
string
required
Absolute HTTPS endpoint of the S3-compatible service (10-200 characters).
string
required
Sensitive third-party S3 access key ID (16-128 characters). It is sent to and persisted by TemplateFox and is never returned by this action.
string
Default object-key prefix (maximum 500 characters). Use only letters, digits, underscores, periods, slashes, and hyphens.
string
Sensitive third-party S3 secret access key (16-128 characters). Required for initial setup; omit it during an update to retain the saved secret. It is never returned by this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_UPDATE_TEMPLATE_VERSIONChange or clear the tag and/or description metadata of a template version; the immutable snapshot content is not changed.

Input Parameters

string
New lowercase tag, or null to clear it. Omit this field to leave the tag unchanged.
string
New version description, or null to clear it. Omit this field to leave the description unchanged.
string
required
Exactly 12-character ID of the template whose version to update.
integer
required
Positive version number returned by listing or creating template versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEMPLATEFOX_VALIDATE_S3_CONFIGTest access to the configured S3-compatible bucket using stored credentials, including writing a small test object, without changing the saved credentials.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not