Generate document filename
Generate a structured filename for a document based on a naming schema with placeholders (e.g. “invoice--”). The AI extracts text from the document and uses an LLM to fill in the placeholder values. Cost: 4 credits per request.
Authorizations
API Key (starts with ak_...)
Body
File ID of the document (PDF, DOCX, ODT, or Markdown)
"550e8400-e29b-41d4-a716-446655440000"
Filename schema/pattern with placeholders. E.g. "invoice-{invoiceNr}-{dateCreated}" or "contract-{clientName}-{year}". The AI will extract values from the document and fill in the placeholders.
"invoice-{invoiceNr}-{dateCreated}"
Optional webhook configuration
Response
Filename generation 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.
