The Mathpix connector lets your AI agent act in each user's Mathpix account. Each user connects their own Mathpix API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 15 tools.
- Tools
- 15
- What they doRead · write · destructive
- 11 · 2 · 211 read2 write2 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 Mathpix connection
In AgentKit > Connections, create a Mathpix 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 = 'mathpix'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Mathpix:', 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: 'mathpix_list_ocr_results',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 = "mathpix"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Mathpix:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="mathpix_list_ocr_results",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Mathpix credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolmathpix_get_conversion_resultDownload the text output of a Mathpix Markdown conversion: Markdown, HTML or the source Mathpix Markdown.Read-onlyGet Conversion Result
Download the text output of a Mathpix Markdown conversion: Markdown, HTML or the source Mathpix Markdown. Returns the converted content as text. Use this after mathpix_get_conversion_status shows the format completed. Use mathpix_get_pdf_result for a processed document. Requires a conversion_id from mathpix_convert_markdown.
Inputs
conversion_idstringrequired- The conversion_id returned by mathpix_convert_markdown. Example: 2024_01_15_abc123def456
formatstringrequired- Output to download: md (plain Markdown) or html must have been requested in formats and show completed; mmd returns the submitted Mathpix Markdown.one of
mdhtmlmmd
mathpix_get_conversion_statusCheck the progress of each output format of a Mathpix conversion.Read-onlyGet Conversion Status
Check the progress of each output format of a Mathpix conversion. Returns status and conversion_status, a map from format (docx, md, pdf and so on) to received, loaded, processing, completed or error, with error_info on failure. Use this after mathpix_convert_markdown, or with a pdf_id to track the conversion_formats of mathpix_submit_pdf. Use mathpix_get_pdf_status for a document's OCR progress.
Inputs
conversion_idstringrequired- The conversion_id returned by mathpix_convert_markdown, or a pdf_id from mathpix_submit_pdf to check that document's conversion formats. Example: 2024_01_15_abc123def456
mathpix_get_ocr_usageGet Mathpix API usage counts over a date range, grouped by usage type, request settings or app.Read-onlyGet OCR Usage
Get Mathpix API usage counts over a date range, grouped by usage type, request settings or app. Returns ocr_usage, one record per period and group with from_date, app_id, usage_type, request_args_hash and count. Use this to track consumption or reconcile billing. Use mathpix_list_ocr_results to see the individual results.
Inputs
group_bystringrequired- How to aggregate the counts: usage_type (image, image-async, pdf pages and so on), request_args_hash (identical request settings) or app_id.one of
usage_typerequest_args_hashapp_id timespanstringrequired- Length of each aggregation period. Mathpix's documentation shows month; it does not list other values. Example: month
from_datestring- Only include results at or after this ISO 8601 date-time (inclusive). Example: 2026-07-01T00:00:00.000Z
to_datestring- Only include results before this ISO 8601 date-time (exclusive). Example: 2026-08-01T00:00:00.000Z
mathpix_get_pdf_linesDownload line-by-line data for a processed document.Read-onlyGet PDF Lines
Download line-by-line data for a processed document. Returns pages, each with page number, size and lines carrying type, text, Mathpix Markdown (text_display), bounding region, contour and confidence. Use this to locate content on the page or filter by confidence. Use mathpix_get_pdf_result for the document as one Markdown or HTML text. Requires a pdf_id whose status is completed.
Inputs
pdf_idstringrequired- The pdf_id returned by mathpix_submit_pdf, or the id field from mathpix_list_pdf_results. Example: 2024_01_15_abc123def456
mathpix_get_pdf_resultDownload the text output of a processed document: Mathpix Markdown, plain Markdown or HTML.Read-onlyGet PDF Result
Download the text output of a processed document: Mathpix Markdown, plain Markdown or HTML. Returns the document content as text. Use this to read a document after mathpix_get_pdf_status shows completed. Use mathpix_get_pdf_lines for per-line positions and confidence. Requires a pdf_id from mathpix_submit_pdf.
Inputs
formatstringrequired- Output to download: mmd is Mathpix Markdown (always available once processing completes), md is plain Markdown, html is HTML. md and html are converted on demand if they were not requested at submission; while that runs Mathpix answers 202 with a status object instead of the content. A 404 with a status object means the document is not finished yet.one of
mmdmdhtml pdf_idstringrequired- The pdf_id returned by mathpix_submit_pdf, or the id field from mathpix_list_pdf_results. Example: 2024_01_15_abc123def456
mathpix_get_pdf_statusCheck the processing status of a document submitted with mathpix_submit_pdf.Read-onlyGet PDF Status
Check the processing status of a document submitted with mathpix_submit_pdf. Returns status (received, loaded, split, completed or error), num_pages, num_pages_completed, percent_done and conversion_status for each requested format. Poll this until status is completed before calling mathpix_get_pdf_result; percent_done reaches 100 before the output is ready. Use mathpix_get_conversion_status for conversion progress only.
Inputs
pdf_idstringrequired- The pdf_id returned by mathpix_submit_pdf, or the id field from mathpix_list_pdf_results. Example: 2024_01_15_abc123def456
mathpix_list_ocr_resultsList past Mathpix image results (from image, equation, strokes and document requests), newest first, with filters for date, tags, text and content type.Read-onlyList OCR Results
List past Mathpix image results (from image, equation, strokes and document requests), newest first, with filters for date, tags, text and content type. Returns ocr_results, each with timestamp, endpoint, image_id, request_args, the full result and detections such as is_handwritten or contains_table. Use this to find earlier image OCR results. Use mathpix_list_pdf_results for document jobs. Results sent with improve_mathpix set to false are not listed.
Inputs
app_idstring- Only include results from this Mathpix app ID, for accounts with several apps. Example: mycompany_abc123
contains_chemistryboolean- Set to true to include only results that contain a chemistry diagram.
contains_diagramboolean- Set to true to include only results that contain a diagram.
contains_tableboolean- Set to true to include only results that contain a table.
from_datestring- Only include results at or after this ISO 8601 date-time (inclusive). Example: 2026-07-01T00:00:00.000Z
is_handwrittenboolean- Set to true to include only results that contain handwritten text or math.
is_printedboolean- Set to true to include only results that contain printed text or math.
latex_styledstring- Only include results whose latex_styled output contains this string. Example: \frac
pageinteger- Page of results to return, starting at 1 (maximum 10000). Mathpix default: 1.
per_pageinteger- Number of results per page. Mathpix default: 100.
tagsarray- Only include results that carry these tags (set with the tags input of the processing tools). Example: ["homework"]
textstring- Only include results whose text output contains this string. Example: x^{2}
to_datestring- Only include results before this ISO 8601 date-time (exclusive). Example: 2026-08-01T00:00:00.000Z
mathpix_list_pdf_resultsList documents previously submitted to Mathpix, with an optional date range.Read-onlyList PDF Results
List documents previously submitted to Mathpix, with an optional date range. Returns pdfs, each with id, input_file, status, created_at, modified_at, num_pages, num_pages_completed and request_args. Use this to find a pdf_id you no longer have. Use mathpix_get_pdf_status for one document's current status, and mathpix_list_ocr_results for image results.
Inputs
app_idstring- Only include results from this Mathpix app ID, for accounts with several apps. Example: mycompany_abc123
from_datestring- Only include results at or after this ISO 8601 date-time (inclusive). Example: 2026-07-01T00:00:00.000Z
pageinteger- Page of results to return, starting at 1 (maximum 10000). Mathpix default: 1.
per_pageinteger- Number of results per page. Mathpix default: 100.
to_datestring- Only include results before this ISO 8601 date-time (exclusive). Example: 2026-08-01T00:00:00.000Z
mathpix_process_equationRead one equation image with Mathpix's legacy equation endpoint and return it in the LaTeX and math notations you choose.Read-onlyProcess Equation
Read one equation image with Mathpix's legacy equation endpoint and return it in the LaTeX and math notations you choose. Returns the requested formats (for example latex_styled, latex_simplified, mathml, asciimath, wolfram), latex_confidence and, with n_best, alternative candidates. Use this when you need MathML, AsciiMath, Wolfram or simplified LaTeX for a single equation. Use mathpix_process_image for everything else; Mathpix recommends it for new work.
Inputs
formatsarrayrequired- LaTeX and math formats to return. text and text_display give text with math in delimiters; latex_normal, latex_styled and latex_simplified are LaTeX variants (styled adds \left/\right for appearance, simplified shortens operators for symbolic processing); latex_list splits several equations into a list; mathml, asciimath and wolfram give those notations (wolfram is ready for Wolfram Alpha). Example: ["latex_styled", "asciimath"]
srcstringrequired- The equation image to read, as a public image URL (http or https) or a base64 data URL such as data:image/png;base64,iVBORw0KGgo... Supported image types include JPEG, PNG, WebP, BMP and TIFF. Mathpix downloads URLs itself (up to 10 MB, 15 second timeout); a base64 image must be 2 MB or less. Example: https://mathpix-ocr-examples.s3.amazonaws.com/cases_hw.jpg
beam_sizeinteger- Number of candidate results (1 to 10) Mathpix considers during recognition. Needed when n_best is set. Example: 5
confidence_thresholdnumber- Minimum confidence between 0 and 1. When the result's confidence is below this value, Mathpix returns a math_confidence error instead of a result. Example: 0.5
displaymath_delimsarray- Begin and end delimiters for display math in the text formats (sent as format_options.displaymath_delims), as a two-item list. Example: ["$$", "$$"]
improve_mathpixboolean- Set to false to stop Mathpix from keeping this request's image and result to improve its models (sent as metadata.improve_mathpix). Results sent with false do not appear in mathpix_list_ocr_results.
include_detected_alphabetsboolean- Return detected_alphabets, which flags each alphabet (en, ru, zh and so on) found in the image.
math_delimsarray- Begin and end delimiters for inline math in the text formats (sent as format_options.math_delims), as a two-item list. Example: ["$", "$"]
n_bestinteger- Number of highest-confidence alternatives to return in candidates, from 1 up to beam_size. Requires beam_size. Example: 3
ocrarray- What to read: ["math"] (the default) reads math only; ["math", "text"] also reads the text around it.
regionobject- Restrict recognition to one rectangle of the image, in pixels. Give all four keys: top_left_x, top_left_y, width and height. Example: {"top_left_x": 0, "top_left_y": 0, "width": 400, "height": 120}
skip_recropboolean- Read the whole image instead of letting Mathpix crop to the area it thinks holds the equation.
tagsarray- Labels stored with this result so it can be found later with mathpix_list_ocr_results. Example: ["homework", "batch-42"]
transformsarray- Clean-up steps applied to the LaTeX formats (sent as format_options.transforms): rm_spaces removes superfluous spaces, rm_newlines joins text lines with spaces, rm_fonts drops mathbb/mathbf/mathcal/mathrm, rm_style_syms replaces styled symbols with plain ones, rm_text drops text left or right of the math, long_frac turns long division into a fraction. Example: ["rm_spaces", "rm_fonts"]
mathpix_process_imageRead the math, text, tables and chemistry diagrams in one image (printed or handwritten) with Mathpix OCR.Read-onlyProcess Image
Read the math, text, tables and chemistry diagrams in one image (printed or handwritten) with Mathpix OCR. Returns Mathpix Markdown in text, with optional html, latex_styled, data, line_data or word_data, plus confidence and is_handwritten / is_printed flags. Use this for photos, screenshots and scans of a single image. Use mathpix_submit_pdf for PDFs and other multi-page documents, and mathpix_process_strokes for pen-stroke coordinates.
Inputs
srcstringrequired- The image to read, as a public image URL (http or https) or a base64 data URL such as data:image/png;base64,iVBORw0KGgo... Supported image types include JPEG, PNG, WebP, BMP and TIFF. Mathpix downloads URLs itself (up to 10 MB, 15 second timeout); a base64 image must be 2 MB or less. Example: https://mathpix-ocr-examples.s3.amazonaws.com/cases_hw.jpg
alphabets_allowedobject- Alphabets to suppress in the output, as a map from alphabet code to false. Codes: en, hi, zh, ja, ko, ru, th, ta, te, gu, bn, vi. All alphabets are allowed by default; suppressing unused ones avoids look-alike characters such as Latin B and Cyrillic В. Example: {"ru": false, "hi": false}
confidence_thresholdnumber- Minimum confidence between 0 and 1. When the result's confidence is below this value, Mathpix returns a math_confidence error instead of a result. Example: 0.5
data_optionsobject- Extra representations to include in the data and html outputs. Each key is a boolean flag: include_asciimath, include_latex, include_mathml and include_svg add math in that notation; include_table_html and include_tsv add tables as HTML or tab-separated values; include_sub_math splits math into sub-expressions. Only these keys are accepted. Example: {"include_asciimath": true, "include_tsv": true}
enable_document_layoutboolean- Treat the image as a full document page: improves multi-line page parsing and produces structured output such as nested lists and pseudocode blocks. Leave off (the default) for snippets such as a single equation or paragraph.
formatsarray- Output formats to return. text is Mathpix Markdown with math inside \( \) and \[ \] delimiters; html is HTML rendered from it; data returns math, tables and other elements in the formats chosen with data_options; latex_styled returns one LaTeX string when the whole image is a single equation. Omit to return text only. Example: ["text", "latex_styled"]
idiomatic_bracesboolean- Remove unnecessary braces from LaTeX output, so x^2 is returned instead of x^{2}. Mathpix default: false.
idiomatic_eqn_arraysboolean- Use aligned, gathered or cases environments instead of array for a list of equations. Mathpix default: false.
improve_mathpixboolean- Set to false to stop Mathpix from keeping this request's image and result to improve its models (sent as metadata.improve_mathpix). Results sent with false do not appear in mathpix_list_ocr_results.
include_detected_alphabetsboolean- Return detected_alphabets, which flags each alphabet (en, ru, zh and so on) found in the image.
include_equation_tagsboolean- Keep equation numbers inside the LaTeX as \tag{1.12}. Setting this to true also turns on idiomatic equation arrays.
include_inchiboolean- Add InChI and InChI key attributes to each <smiles> element. Only applies when include_smiles is true.
include_line_databoolean- Return line_data: one entry per detected line with its type (text, math, table, diagram and so on), contour coordinates, confidence and whether it is part of the main output.
include_smilesboolean- Recognize chemistry structure diagrams and return them as SMILES inside <smiles>...</smiles> in the text output (experimental). Mathpix default: false.
include_word_databoolean- Return word_data: one entry per detected word with its text, contour coordinates and confidence. Cannot be combined with enable_document_layout.
math_display_delimitersarray- Begin and end delimiters for display (block) math in the text output, as a two-item list. Default is ["\\[", "\\]"]. Example: ["$$", "$$"]
math_inline_delimitersarray- Begin and end delimiters for inline math in the text output, as a two-item list. Default is ["\\(", "\\)"]. Example: ["$", "$"]
numbers_default_to_mathboolean- Always treat numbers as math, so "Answer: 17" becomes "Answer: \( 17 \)". Mathpix default: false.
regionobject- Restrict recognition to one rectangle of the image, in pixels. Give all four keys: top_left_x, top_left_y, width and height. Example: {"top_left_x": 0, "top_left_y": 0, "width": 400, "height": 120}
rm_fontsboolean- Remove font commands such as \mathbf and \mathrm from equations in the latex_styled and text outputs. Mathpix default: false.
rm_spacesboolean- Remove extra white space from equations in the latex_styled and text outputs. Mathpix default: true.
tagsarray- Labels stored with this result so it can be found later with mathpix_list_ocr_results. Example: ["homework", "batch-42"]
mathpix_process_strokesRecognize handwriting (math and text) from digital ink stroke coordinates, without rendering an image first.Read-onlyProcess Handwriting Strokes
Recognize handwriting (math and text) from digital ink stroke coordinates, without rendering an image first. Returns Mathpix Markdown in text, latex_styled when the input is one expression, optional html and data, plus confidence. Use this when you have pen or touch coordinates from a canvas or stylus. Use mathpix_process_image when you have a picture of the handwriting.
Inputs
xarrayrequired- X coordinates of the handwriting, one list per pen stroke, in the order the strokes were drawn. Must line up with y: the same number of strokes and the same number of points in each. Example: [[131, 133, 140], [231, 233, 235]]
yarrayrequired- Y coordinates of the handwriting, one list per pen stroke, matching x point for point. Example: [[213, 212, 210], [231, 232, 235]]
confidence_thresholdnumber- Minimum confidence between 0 and 1. When the result's confidence is below this value, Mathpix returns a math_confidence error instead of a result. Example: 0.5
data_optionsobject- Extra representations to include in the data and html outputs. Each key is a boolean flag: include_asciimath, include_latex, include_mathml and include_svg add math in that notation; include_table_html and include_tsv add tables as HTML or tab-separated values; include_sub_math splits math into sub-expressions. Only these keys are accepted. Example: {"include_asciimath": true, "include_tsv": true}
formatsarray- Output formats to return. text is Mathpix Markdown with math inside \( \) and \[ \] delimiters; html is HTML rendered from it; data returns math, tables and other elements in the formats chosen with data_options; latex_styled returns one LaTeX string when the whole image is a single equation. Omit to return text only. Example: ["text", "latex_styled"]
idiomatic_bracesboolean- Remove unnecessary braces from LaTeX output, so x^2 is returned instead of x^{2}. Mathpix default: false.
idiomatic_eqn_arraysboolean- Use aligned, gathered or cases environments instead of array for a list of equations. Mathpix default: false.
improve_mathpixboolean- Set to false to stop Mathpix from keeping this request's image and result to improve its models (sent as metadata.improve_mathpix). Results sent with false do not appear in mathpix_list_ocr_results.
include_equation_tagsboolean- Keep equation numbers inside the LaTeX as \tag{1.12}. Setting this to true also turns on idiomatic equation arrays.
math_display_delimitersarray- Begin and end delimiters for display (block) math in the text output, as a two-item list. Default is ["\\[", "\\]"]. Example: ["$$", "$$"]
math_inline_delimitersarray- Begin and end delimiters for inline math in the text output, as a two-item list. Default is ["\\(", "\\)"]. Example: ["$", "$"]
numbers_default_to_mathboolean- Always treat numbers as math, so "Answer: 17" becomes "Answer: \( 17 \)". Mathpix default: false.
rm_fontsboolean- Remove font commands such as \mathbf and \mathrm from equations in the latex_styled and text outputs. Mathpix default: false.
rm_spacesboolean- Remove extra white space from equations in the latex_styled and text outputs. Mathpix default: true.
tagsarray- Labels stored with this result so it can be found later with mathpix_list_ocr_results. Example: ["homework", "batch-42"]
mathpix_convert_markdownConvert a Mathpix Markdown document into DOCX, Markdown, HTML, PDF, LaTeX, PowerPoint or Excel.WriteConvert Markdown
Convert a Mathpix Markdown document into DOCX, Markdown, HTML, PDF, LaTeX, PowerPoint or Excel. Returns conversion_id, the handle for status checks and downloads. Use this for Markdown you already have. Use the conversion_formats input of mathpix_submit_pdf to convert a document while it is processed. Poll mathpix_get_conversion_status until each format is completed, then read text formats with mathpix_get_conversion_result.
Inputs
formatsarrayrequired- Output formats to produce. md and html are text and can be read with mathpix_get_conversion_result; docx, xlsx (tables only), pptx, pdf, latex.pdf and the zip formats are binary files. Example: ["docx", "tex.zip"]
mmdstringrequired- The Mathpix Markdown (MMD) document to convert, as one string. MMD is Markdown with LaTeX math in \( \) and \[ \] delimiters, as returned by mathpix_process_image or mathpix_get_pdf_result. The request body can be up to 10 MB. Example: # Notes\n\nThe area is \( \pi r^2 \).
conversion_optionsobject- Settings for specific formats, keyed by format name. For example docx takes font, fontSize (half-points), orientation and margins; md takes math delimiters and escape flags; pdf takes fontSize, margin and custom_css; html takes math_output_format (svg, mathml or latex). Example: {"docx": {"font": "Arial", "fontSize": 24}}
improve_mathpixboolean- Set to false to stop Mathpix from keeping this request's image and result to improve its models (sent as metadata.improve_mathpix). Results sent with false do not appear in mathpix_list_ocr_results.
mathpix_submit_pdfStart asynchronous Mathpix OCR of a PDF, Word, PowerPoint or ebook file from a public URL.WriteSubmit PDF
Start asynchronous Mathpix OCR of a PDF, Word, PowerPoint or ebook file from a public URL. Returns pdf_id, the handle for status checks and result downloads. Use this for multi-page documents. Use mathpix_process_image for a single image. Poll mathpix_get_pdf_status until status is completed, then read the output with mathpix_get_pdf_result or mathpix_get_pdf_lines.
Inputs
urlstringrequired- Public http(s) URL Mathpix downloads the document from. Accepts PDF, DOCX, DOC, PPTX, ODT, WPD, EPUB, MOBI, AZW/AZW3/KFX and DJVU, up to 1 GB. Example: https://cdn.mathpix.com/examples/cs229-notes1.pdf
alphabets_allowedobject- Alphabets to suppress in the output, as a map from alphabet code to false. Codes: en, hi, zh, ja, ko, ru, th, ta, te, gu, bn, vi. All alphabets are allowed by default; suppressing unused ones avoids look-alike characters such as Latin B and Cyrillic В. Example: {"ru": false, "hi": false}
conversion_formatsarray- Extra output formats to produce once processing finishes, on top of Mathpix Markdown (mmd) and lines.json, which are always produced. md and html are text and can be read with mathpix_get_pdf_result; docx, xlsx, pptx, pdf, latex.pdf, mmd.overlay.pdf and the zip formats are binary files. Example: ["md", "docx"]
conversion_optionsobject- Settings for specific conversion formats, keyed by format name. For example docx takes font, fontSize (half-points), orientation and margins; md takes math delimiters and escape flags; pdf takes fontSize, margin and custom_css; html takes math_output_format (svg, mathml or latex). Example: {"docx": {"font": "Arial", "orientation": "landscape"}}
disable_itemizeboolean- Emit list items as plain lines with their markers (1., -, and so on) instead of \begin{itemize} environments. Mathpix default: false.
disable_lstlistingboolean- Emit code and pseudocode as Markdown triple-backtick fences instead of \begin{lstlisting} blocks. Mathpix default: false.
idiomatic_eqn_arraysboolean- Use aligned, gathered or cases environments instead of array for a list of equations. Mathpix default: false.
improve_mathpixboolean- Set to false to stop Mathpix from keeping this request's image and result to improve its models (sent as metadata.improve_mathpix). Results sent with false do not appear in mathpix_list_ocr_results.
include_chemistry_as_imageboolean- Return each chemistry diagram as an image crop, with its SMILES in the image alt text. Mathpix default: false.
include_equation_tagsboolean- Keep equation numbers inside the LaTeX as \tag{1.12}. Setting this to true also turns on idiomatic equation arrays.
include_hyperlinksboolean- Keep the http, https and mailto links stored in the PDF as Markdown links in the output. Mathpix default: false.
include_page_breaksboolean- Append a \pagebreak marker after each page in the Mathpix Markdown output. Mathpix default: false.
include_smilesboolean- Recognize chemistry structure diagrams as SMILES inside <smiles>...</smiles>. Mathpix default for documents: true.
math_display_delimitersarray- Begin and end delimiters for display (block) math in the text output, as a two-item list. Default is ["\\[", "\\]"]. Example: ["$$", "$$"]
math_inline_delimitersarray- Begin and end delimiters for inline math in the text output, as a two-item list. Default is ["\\(", "\\)"]. Example: ["$", "$"]
numbers_default_to_mathboolean- Always treat numbers as math, so "Answer: 17" becomes "Answer: \( 17 \)". Mathpix default: false.
page_rangesstring- Pages to process, as a comma-separated list of pages and ranges. Negative numbers count from the end. Example: 2,4-6 for pages 2, 4, 5 and 6; 2 - -2 for the second through the next-to-last page.
rm_fontsboolean- Remove font commands such as \mathbf and \mathrm from equations in the latex_styled and text outputs. Mathpix default: false.
rm_spacesboolean- Remove extra white space from equations in the latex_styled and text outputs. Mathpix default: true.
section_numberingstring- How to handle section and subsection numbers: preserve keeps existing numbering as is (the Mathpix default), auto numbers sections automatically, remove strips existing numbering. Sent as the matching auto_number_sections, remove_section_numbering or preserve_section_numbering flag.one of
preserveautoremove
mathpix_delete_conversionPermanently delete all output files of a Mathpix Markdown conversion.DestructiveDelete Conversion
Permanently delete all output files of a Mathpix Markdown conversion. This cannot be undone. Returns the conversion's status object as it was at deletion. Use this to remove converted files from Mathpix. Use mathpix_delete_pdf for a processed document. Download any output you need with mathpix_get_conversion_result first.
- Idempotent
Inputs
conversion_idstringrequired- The conversion_id of the conversion to delete, from mathpix_convert_markdown. Example: 2024_01_15_abc123def456
mathpix_delete_pdfPermanently delete a processed document's outputs and its uploaded input file from Mathpix.DestructiveDelete PDF
Permanently delete a processed document's outputs and its uploaded input file from Mathpix. This cannot be undone. Returns the document's status object as it was at deletion. Use this to remove a document's data before Mathpix's automatic retention period ends. Use mathpix_delete_conversion for a Markdown conversion. Download any output you need with mathpix_get_pdf_result first.
- Idempotent
Inputs
pdf_idstringrequired- The pdf_id of the document to delete, from mathpix_submit_pdf or mathpix_list_pdf_results. Example: 2024_01_15_abc123def456
No tools match.
