Replace placeholders in DOCX/ODT
Replace tags in a DOCX or ODT document with provided values. Supports text, images, lists, and tables. Output format is configurable.
Authorizations
API Key (starts with ak_...)
Body
File ID of the DOCX or ODT file with placeholders
"550e8400-e29b-41d4-a716-446655440000"
Map of placeholder names to values. Use string for text, or an object with type for images/lists/tables. Placeholders in the document use {{name}} or ${name} syntax.
Output format. Default: same as input format. Use "pdf" to get a PDF output.
pdf, docx, odt "pdf"
Optional webhook configuration
Response
Placeholder replacement job created
Job ID
"550e8400-e29b-41d4-a716-446655440000"
Action that was performed
"pdf.merge"
Current job status
PENDING, PROCESSING, COMPLETED, FAILED "PENDING"
Input file IDs used for this job
Output file ID (available when COMPLETED)
null
Error message (available when FAILED)
null
Job creation timestamp
Job start timestamp
Job completion timestamp
Structured job result data (e.g. OCR markdown/JSON, generated filename, PDF metadata, form fields). Available when the job produces a direct result instead of an output file.
Deprecated — use result instead. Additional metadata, duplicated from result for backward compatibility.
