Skip to main content
Mathpix logo
  • Category: documents & ocr
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 29
  • Triggers: 0
  • Slug: MATHPIX
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: MATHPIX_CONVERT_MATHPIX_MARKDOWNSubmit Mathpix Markdown, wait for one requested format to finish, then return the conversion ID and downloadable output file. The remote conversion remains if waiting fails or times out.

Input Parameters

object
Optional JSON metadata stored with the conversion for correlation.
string ("md" | "docx" | "tex.zip" | "html" | "pdf" | "latex.pdf" | "pptx" | "xlsx" | "mmd.zip" | "md.zip" | "html.zip")
Single output format to request, wait for, and download.
number
Maximum total time to wait before failing with the conversion ID (10-900 seconds).
string
required
Mathpix Markdown source to convert; the complete JSON request must remain under 10 MB.
number
Seconds between conversion status checks (1-30).

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: MATHPIX_CREATE_APP_TOKENMint a short-lived client OCR credential, optionally with a live ink strokes session. Requires explicit acknowledgement because the response exposes the new secret exactly once to the caller.

Input Parameters

string
Optional caller-owned user identifier associated with the token.
integer
Token lifetime in seconds, from 30 seconds through 12 hours.
boolean
Also create a strokes session ID for client-side live ink recognition. This limits expires_seconds to at most 300 seconds.
boolean
required
Must be true to acknowledge that the response contains a live credential that must not be logged, persisted insecurely, or shared with an untrusted client.

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: MATHPIX_DELETE_CONVERSIONPermanently delete one Mathpix Markdown conversion’s hosted output data after explicit confirmation. The response preserves the status immediately before deletion; Mathpix may continue to report that status after the output data has been deleted.

Input Parameters

string
required
Conversion ID whose hosted outputs will be permanently deleted.
boolean
required
Must be true to confirm permanent deletion of the conversion’s hosted outputs.

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: MATHPIX_DELETE_DOCUMENTPermanently delete one Mathpix document source and its hosted outputs after explicit confirmation. The response reports the status immediately before deletion, not a deleted status marker, and cached downloads may remain reachable for up to 10 minutes.

Input Parameters

string
required
Document job ID whose Mathpix-hosted source and outputs will be permanently deleted.
boolean
required
Must be true to confirm permanent deletion of the document source and hosted outputs.

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: MATHPIX_DELETE_FILEPermanently delete one terminal Files API file and its Mathpix-hosted results. This does not remove customer-owned destination objects, reverse billing, or delete a file that is still processing.

Input Parameters

string
required
Terminal Files API file ID to permanently delete.
boolean
required
Must be true to confirm permanent deletion of Mathpix-hosted file data.

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: MATHPIX_FINALIZE_FILE_JOBPermanently close one Files API job to new file additions and arm its completion webhook. Already accepted files may continue processing. Requires explicit confirmation; repeating the same finalization is provider-idempotent.

Input Parameters

string
required
Files API job to close permanently to new file additions.
boolean
required
Must be true to confirm that no more files can be added to this job.

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: MATHPIX_GET_APP_TOKENGet expiry and ownership metadata for a specific short-lived Mathpix app token. The secret token is used only in the request path and is omitted from the returned object and provider-error diagnostics.

Input Parameters

string
required
Secret app token whose expiry and ownership metadata to inspect. Use only a token obtained from a trusted source.

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: MATHPIX_GET_CONVERSION_RESULTWait for an existing Mathpix Markdown conversion and requested format to finish, then return its status and downloadable output file without creating a conversion.

Input Parameters

string
required
Conversion ID returned by Convert Mathpix Markdown or Mathpix.
string ("md" | "docx" | "tex.zip" | "html" | "pdf" | "latex.pdf" | "pptx" | "xlsx" | "mmd.zip" | "md.zip" | "html.zip")
Previously requested output format to wait for and download.
number
Maximum total time to wait before failing without deleting the conversion.
number
Seconds between conversion status checks.

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: MATHPIX_GET_DOCUMENT_RESULTWait for an existing Mathpix document job and requested format to finish, then return its status and downloadable output file without creating a new job.

Input Parameters

string
required
Document job ID returned by OCR Document or Mathpix.
string ("mmd" | "md" | "docx" | "tex.zip" | "html" | "pdf" | "latex.pdf" | "pptx" | "xlsx" | "mmd.zip" | "md.zip" | "html.zip" | "lines.json" | "lines.mmd.json")
Previously requested output format to wait for and download.
number
Maximum total time to wait before failing without deleting the job.
number
Seconds between status checks while waiting for the output.

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: MATHPIX_GET_FILE_JOBGet aggregate status, file and page counters, and timestamps for one Files API job. A completed job can still contain errored files; inspect files_errored and has_file_errors.

Input Parameters

string
required
Files API job ID to inspect.

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: MATHPIX_GET_FILE_RESULTWait for an existing Files API file and selected format to finish, then return its status and downloadable output without creating a file.

Input Parameters

string
required
Files API file ID to retrieve.
string ("mmd" | "md" | "docx" | "tex.zip" | "html" | "pdf" | "latex.pdf" | "pptx" | "xlsx" | "mmd.zip" | "md.zip" | "html.zip" | "lines.json" | "lines.mmd.json")
Previously requested output format to wait for and download.
number
Maximum wait before failing without deleting the file.
number
Seconds between file status checks.

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: MATHPIX_GET_JOB_FILE_BY_CUSTOM_IDGet the complete Files API processing status for one job member using the exact caller-defined custom ID assigned at submission.

Input Parameters

string
required
Files API job containing the member file.
string
required
Exact case-sensitive caller-defined ID assigned when this job member was submitted.

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: MATHPIX_GET_OCR_USAGEReturn one page of aggregated Mathpix OCR usage for a date range, optionally grouped by usage type, request configuration, or application.

Input Parameters

string
Exclusive end date/time for the usage query in Mathpix’s accepted format.
array
Dimensions used to aggregate usage rows. Multiple values are sent as repeated group_by query parameters.
string
Mathpix-supported time bucket for aggregating usage, such as month.
string
Inclusive start date/time for the usage query in Mathpix’s accepted format.
integer
Maximum usage rows to request in this page; Mathpix does not document a maximum.
string
Filter to a Mathpix usage category such as image or document processing.
string
Continuation cursor returned by a previous call; omit for the first page.
string
Filter to the hash of one OCR request configuration.

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: MATHPIX_GET_STORAGE_ONBOARDING_IDENTITIESGet the Mathpix AWS, Azure, and GCP identities needed to grant cloud-storage access. Requires explicit acknowledgement because the first call may lazily create the account’s immutable external ID.

Input Parameters

boolean
required
Must be true to acknowledge that the first call may permanently create the Mathpix account’s immutable external 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: MATHPIX_LIST_CONVERSIONSList one page of retained Mathpix Markdown conversion records, optionally filtered by date, and return IDs usable by conversion result or deletion tools.

Input Parameters

string
Exclusive end date/time filter in the format accepted by Mathpix.
string
Inclusive start date/time filter in the format accepted by Mathpix.
integer
Maximum retained conversion records to request in this page. Mathpix does not publish a verified maximum.
string
Continuation cursor returned by a previous call; omit for the first 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: MATHPIX_LIST_DATA_SOURCESList cloud-storage data sources registered with Mathpix, returning only allowlisted non-secret metadata.

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: MATHPIX_LIST_DOCUMENTSList retained document OCR jobs for the connected account, optionally filtered by date or document ID, and return one page.

Input Parameters

string
Filter to one document job ID.
string
Exclusive end date/time filter in the format accepted by Mathpix.
string
Inclusive start date/time filter in the format accepted by Mathpix.
integer
Maximum document records to request in this page. Mathpix does not publish a maximum.
string
Continuation cursor returned by a previous call; omit for the first 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: MATHPIX_LIST_FILE_JOB_FILESList one cursor-paginated page of files in a Mathpix Files API job, optionally filtered by member status.

Input Parameters

string
required
Files API job whose member files to list.
string ("pending" | "split" | "completed" | "error")
Optional member status filter: pending, split, completed, or error.
integer
Maximum job files to return in this page (1-1000).
string
Opaque continuation cursor from a previous page; omit for the first 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: MATHPIX_LIST_FILE_JOBSList one cursor-paginated page of Files API jobs newest first, optionally bounded by inclusive UTC dates.

Input Parameters

string
Inclusive UTC end date in yyyy-MM-dd format.
integer
Maximum jobs to return in this page (1-1000).
string
Inclusive UTC start date in yyyy-MM-dd format.
string
Opaque continuation cursor returned by a previous call; omit for the first 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: MATHPIX_OCR_DOCUMENTSubmit a PDF, office document, or ebook URL, wait for OCR and the requested conversion to finish, then return its Mathpix job ID and downloadable output file. Mathpix retains the remote job after success; call Delete Document when the hosted source and outputs are no longer needed.

Input Parameters

object
Optional JSON metadata stored with the document job for correlation.
string
required
Public URL of the PDF, office document, or ebook to process.
string ("mmd" | "md" | "docx" | "tex.zip" | "html" | "pdf" | "latex.pdf" | "pptx" | "xlsx" | "mmd.zip" | "md.zip" | "html.zip" | "lines.json" | "lines.mmd.json")
Single output format to request, wait for, and download.
number
Maximum total time to wait for OCR and conversion before failing.
number
Seconds between status checks while waiting for the output.

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: MATHPIX_OCR_IMAGEExtract text, math, tables, diagrams, or chemistry from one image URL or base64 data URI and return the requested OCR representations. Mathpix may retain the submitted image and result, and provides no image deletion endpoint.Instant: Supported on the latest version.Instant pricing: $0.002 per image OCR request

Input Parameters

array
Optional labels stored with the OCR request for later history searches.
array
OCR representations to return; choose one or more of text, structured data, HTML, or styled LaTeX.
object
Optional JSON metadata stored with the OCR request for correlation.
string
required
Image to recognize: a base64 data URI (the whole request must stay under 5 MB), or a URL Mathpix can download without login (not expired, under 10 MB, served within 15 seconds).

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: MATHPIX_PROCESS_EQUATION_DEPRECATEDCompatibility-only access to Mathpix’s deprecated equation-image OCR endpoint. Use MATHPIX_OCR_IMAGE for all new image OCR work. This paid operation may retain the submitted image and result in Mathpix history.

Input Parameters

array
required
One or more legacy equation output representations to return.
object
Optional documented legacy OCR settings, such as tags, async, ocr, format_options, skip_recrop, confidence_threshold, beam_size, n_best, region, callback, metadata, include_detected_alphabets, auto_rotate_confidence_threshold, or enable_blue_hsv_filter. The reserved src and formats fields must be supplied through image_source and formats.
string
required
Public equation-image URL or base64 data URI.

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: MATHPIX_PROCESS_FILE_URISubmit one public or registered-cloud document URI to the paid Files API, wait for OCR and one requested output, and return the retained file ID and downloadable result. Supply an idempotency key for safely retryable standalone submissions. External storage writes or callback delivery require explicit authorization.

Input Parameters

string
Optional existing unfinalized Files job to receive this file.
string
Optional source filename shown in file status and output names.
string
Caller-defined per-job file ID. Requires job_id; reusing the same job_id and custom_id safely deduplicates a retry.
string
required
Public HTTPS URL, s3 URI, gs URI, or Azure Blob HTTPS URL for a document. Cloud locations must have a registered Mathpix data source.
string ("mmd" | "md" | "md.zip" | "mmd.zip" | "docx" | "pptx" | "xlsx" | "html" | "html.zip" | "tex.zip" | "latex.pdf" | "pdf" | "lines.json" | "lines.mmd.json")
Single output format to request, wait for, and download.
string
Optional registered s3, gs, or Azure Blob destination. Mathpix writes the requested output outside Mathpix when this is set.
string
Stable key for safely retrying the identical standalone submission. Use job_id plus custom_id instead for a job-associated file.
number
Maximum total time to wait for OCR and the selected output.
object
Optional documented PDF OCR, conversion, callback, destination-basename, and image-output settings. Dedicated tool fields cannot be overridden.
number
Seconds between file-status checks while waiting for the output.
boolean
Set true when destination_uri is supplied or processing_options includes callback_url, confirming authorization for external storage writes or callback delivery.

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: MATHPIX_PROCESS_IMAGE_BATCHSubmit a paid asynchronous batch of 1-100 named public image URLs, wait until every key has a semantically successful OCR result, and return the retained batch ID and results. Explicit confirmation is required because Mathpix provides no batch deletion route and may deliver an external callback.

Input Parameters

object
required
Map of 1-100 stable caller-chosen keys to public image URLs or per-image option objects containing a url. This tool cap bounds paid OCR usage per call.
object
Optional correlation metadata retained with the batch.
string
Optional public HTTPS callback for progressive results. Mathpix receives it in callback.post, and this tool still polls as the required fallback.
string ("latex" | "text")
OCR behavior applied across the batch: text or legacy equation LaTeX.
number
Maximum total time to wait for every submitted key (10-1800 seconds).
number
Seconds between batch reads (1-30).
boolean
required
Must be true to confirm paid processing of every image, permanent batch retention, and authorization for callback delivery when callback_url is set.

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: MATHPIX_RECOGNIZE_STROKESRecognize handwritten math or text from aligned x/y digital-ink stroke arrays and return OCR representations. This paid call may retain the result.Instant: Supported on the latest version.Instant pricing: $0.002 per non-session digital-ink request

Input Parameters

array
OCR representations to return.
object
Optional correlation metadata stored with the OCR result.
array
required
X coordinates grouped by stroke; outer and inner lengths must exactly match y_coordinates.
array
required
Y coordinates grouped by stroke; outer and inner lengths must exactly match x_coordinates.

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: MATHPIX_REVOKE_APP_TOKENIrreversibly revoke one short-lived app token immediately. Existing clients using the credential will stop authenticating. Requires explicit confirmation.

Input Parameters

string
required
Secret app token to revoke permanently; never use a token from an untrusted source.
boolean
required
Must be true to confirm immediate, irreversible credential revocation.

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: MATHPIX_SEARCH_OCR_RESULTSSearch retained image and stroke OCR history by date, identifiers, content, tags, or detected content and return one page of results. Only requests made with improve_mathpix enabled are queryable.

Input Parameters

array
Filter to OCR requests carrying these tags.
string
Filter by recognized text content.
string
Filter by recognized styled LaTeX content.
string
Filter OCR records associated with this document job ID.
string
Exclusive end date/time filter in the format accepted by Mathpix.
string
Inclusive start date/time filter in the format accepted by Mathpix.
integer
Maximum OCR records to request in this page; Mathpix does not document a maximum.
string
Return the OCR record with this request ID.
string
Continuation cursor returned by a previous call; omit for the first page.
array
Require selected detected content types. Each selection maps to its corresponding Mathpix detection filter.
boolean
Include retained requests that have no OCR result.

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: MATHPIX_SUBMIT_FILE_JOBSubmit up to 200,000 remote documents in a paid asynchronous Mathpix Files job, subject to a 10 MB encoded request limit. Processing creates retained state and may read or write external storage or deliver callbacks; acceptance does not establish individual file outcomes.

Input Parameters

array
required
One to 200,000 typed remote-file entries. Acceptance is asynchronous; invalid individual entries can become per-file errors after this call returns.
string
Optional caller-chosen job ID. Required when any file has custom_id and useful for deterministic follow-up and per-file idempotency.
object
Optional documented job-wide PDF OCR, callback, and image-output options. It cannot override files, job_id, conversion_formats, or idempotency controls.
string
Stable whole-batch retry key used only when job_id is omitted. Reuse it only with the exact same files and options.
object
Optional output formats applied to every file in the job.
boolean
required
Must be true to confirm the submitted file count, paid processing, deferred item errors, retained state, possible external reads or writes, and authorization for any configured callback delivery.

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: MATHPIX_UPLOAD_AND_PROCESS_FILEUpload one local document to the paid Mathpix Files API, wait until OCR and one requested output are ready, then return the retained Mathpix file ID and a downloadable result. The operation can consume page quota and does not delete the remote file; use Delete File when it is no longer needed. External storage writes or callback delivery require explicit authorization.

Input Parameters

object
required
Local document to upload to Mathpix for asynchronous processing.
string
Existing unfinalized Files job to which Mathpix should add this file.
string
Optional display filename sent as a separate multipart form field.
string
Caller-defined job member ID. Requires job_id.
string ("mmd" | "md" | "md.zip" | "mmd.zip" | "docx" | "pptx" | "xlsx" | "html" | "html.zip" | "tex.zip" | "latex.pdf" | "pdf" | "lines.json" | "lines.mmd.json")
Single output format to request, wait for, and download.
string
Stable key for safely retrying a standalone upload. Do not combine it with job_id; job members use the job_id and custom_id pair instead.
number
Maximum total time to wait for OCR and the selected output.
object
Optional documented Files/PDF OCR, conversion, destination, and callback options. Do not include file, job, filename, idempotency, source, or conversion_formats controls; use this tool’s dedicated fields instead.
number
Seconds between status checks while waiting for processing.
boolean
Set true when processing_options includes destination_uri or callback_url, confirming authorization for external storage writes or callback delivery.

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