Document new file formats and suppress-image-types conversion option - #460
Merged
yoshiamakino merged 9 commits intoSep 29, 2026
Merged
Conversation
- Add input_conversion_options parameter to POST /v2/document with suppress-image-types key (pptx only): hyphen-joined image content type list (e.g. logo-photo) or all, plus a SuppressImages request example - Add ten new file types to both file type lists: xlsm, zip (SCORM), vtt, yaml/yml, properties, strings, md/markdown, and beta resx/odt/rtf - Add format-specific gotchas for all ten formats to document translation best practices (SCORM manifest rules, XLSM lookup-formula pitfall, Markdown front matter issue, RTF unicode escapes, and more) - Extend billing minimums to xlsm and odt - Add per-format upload limits for the new formats to usage and limits - Update the About page format list - Add September 2026 changelog entry
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
xlsm, zip (SCORM), vtt, yaml/yml, properties, strings, md/markdown, resx, odt, and rtf are all in beta, not just resx/odt/rtf. Adds the beta marker to both file type lists, the format gotcha headings, the usage-limits table (single shared beta footnote), the changelog entry, and the About page format list.
Markdown and RESX are 1 MB (not 5/10 MB), ODT is 30 MB on API Pro (not 100 MB), and SCORM is 10 MB on API Pro (not 100 MB). All other rows verified against the per-plan limits table.
The *** footnote for the beta file formats was a bare 'Currently in Beta.' stub. Restore the full sentence so it matches the ** image footnote: beta characters are not billed and not counted against the character threshold.
Merge the image-specific ** footnote and the *** footnote into one generic ** footnote shared by images and the ten new beta formats.
.xlsm and .odt are in beta and beta characters are not billed, so the 50,000-character billing minimum does not apply to them yet.
The 50,000-character minimum applies to the billed document formats (.pptx, .docx, .doc, .xlsx, .pdf). Beta formats are not billed at all, so state the exclusion explicitly.
yoshiamakino
deleted the
docs/new-file-formats-and-suppress-image-types
branch
September 29, 2026 16:41
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the ten new document formats and the new
input_conversion_optionsparameter onPOST /v2/document.input_conversion_options(new parameter)POST /v2/document, wire formatversion:1,key:value,...suppress-image-typeskey (PPTX only): value is a hyphen-joined list of image content types (e.g.logo-photo= suppress logos and photos) orall= every embedded imageSuppressImagesrequest exampleNew file types
Adds to both file type lists (tag description +
fileparam description):xlsm(macro-enabled Excel),zip(SCORM),vtt(WebVTT),yaml/yml,properties,strings,md/markdownresx,odt,rtf(marked "currently in beta")Other updates
#N/Apitfall, Markdown front-matter---known issue, RTF\uXXXXescapes, placeholder preservation in .properties/.strings/RESX, etc.).xlsmand.odt(perBillableCharacterHelper)Notes for reviewers
suppress-image-typesis wired only to the PPTX conversion path (StructuredPptxConversionOptionsApplicatorV1); the docs scope it topptxaccordinglysizeLimitsInBytes); the table values follow the closest analogous format family (text-like formats 1 MB, XML-like 10 MB, document formats 10/30-100 MB). Please confirm against the production feature-set config before merge.openapi.jsonintentionally not touched (CI regenerates it)