|
| 1 | +--- |
| 2 | +title: LaTeX |
| 3 | +description: Compile LaTeX documents into PDFs |
| 4 | +--- |
| 5 | + |
| 6 | +import { BlockInfoCard } from "@/components/ui/block-info-card" |
| 7 | + |
| 8 | +<BlockInfoCard |
| 9 | + type="latex" |
| 10 | + color="#FFFFFF" |
| 11 | +/> |
| 12 | + |
| 13 | +{/* MANUAL-CONTENT-START:intro */} |
| 14 | +[LaTeX](https://www.latex-project.org/) is a typesetting system that is the de facto standard for producing high-quality scientific and technical documents. Unlike word processors, LaTeX uses plain-text markup to describe a document's structure and lets the compiler handle layout, which makes it ideal for documents with mathematical notation, citations, cross-references, and consistent professional formatting. |
| 15 | + |
| 16 | +With LaTeX, you can: |
| 17 | + |
| 18 | +- **Compile documents to PDF**: Turn LaTeX source into a polished, print-ready PDF |
| 19 | +- **Typeset mathematics**: Render equations, theorems, and scientific notation with precision |
| 20 | +- **Choose your compiler**: Build with pdfLaTeX, XeLaTeX, LuaLaTeX, pLaTeX, upLaTeX, or ConTeXt |
| 21 | +- **Include supporting files**: Add images, included `.tex` files, bibliographies, and custom classes or styles to the build |
| 22 | +- **Automate document production**: Generate reports, invoices, certificates, and papers from templates |
| 23 | + |
| 24 | +In Sim, the LaTeX integration enables your agents to compile LaTeX source into PDF files as part of any workflow — no OAuth or API key required. Agents can draft documents in LaTeX, attach supporting resources such as images or BibTeX bibliographies, and produce a finished PDF that downstream blocks can email, upload, or store. Agents can also search the available TeX Live packages and system fonts to pick the right tools for a document. This makes it easy to build agents that generate reports, typeset research digests, or produce templated documents like invoices and certificates. |
| 25 | + |
| 26 | +Note: compilation runs on the public [LaTeX-on-HTTP](https://github.com/YtoTech/latex-on-http) service at latex.ytotech.com, so the document source and any attached resources are sent to that third-party service. Avoid compiling documents whose contents must not leave your environment. |
| 27 | +{/* MANUAL-CONTENT-END */} |
| 28 | + |
| 29 | + |
| 30 | +## Usage Instructions |
| 31 | + |
| 32 | +Integrates LaTeX into the workflow. Compiles LaTeX source into a PDF file with pdflatex, xelatex, lualatex, platex, uplatex, or context, and supports additional resources such as images, included .tex files, and bibliographies. Can also look up the TeX Live packages and system fonts available to the compiler. Does not require OAuth or an API key. Compilation runs on the public LaTeX-on-HTTP service (latex.ytotech.com), so document source and resources are sent to that third-party service. |
| 33 | + |
| 34 | + |
| 35 | + |
| 36 | +## Actions |
| 37 | + |
| 38 | +### `latex_compile` |
| 39 | + |
| 40 | +Compile a LaTeX document into a PDF via the public LaTeX-on-HTTP service (latex.ytotech.com). Supports pdflatex, xelatex, lualatex, platex, uplatex, and context, plus supporting resources such as images, included .tex files, and bibliographies. |
| 41 | + |
| 42 | +#### Input |
| 43 | + |
| 44 | +| Parameter | Type | Required | Description | |
| 45 | +| --------- | ---- | -------- | ----------- | |
| 46 | +| `content` | string | Yes | LaTeX source of the main document, from \\documentclass to \\end\{document\} | |
| 47 | +| `compiler` | string | No | LaTeX compiler: pdflatex \(default\), xelatex, lualatex, platex, uplatex, or context | |
| 48 | +| `fileName` | string | No | Name for the generated PDF file \(default: document.pdf\) | |
| 49 | +| `resources` | array | No | Supporting files for the compilation. Each entry has a "path" plus exactly one of "content" \(plain text\), "file" \(base64\), or "url" \(remote file\), e.g. \[\{"path": "refs.bib", "content": "..."\}, \{"path": "logo.png", "url": "https://..."\}\] | |
| 50 | + |
| 51 | +#### Output |
| 52 | + |
| 53 | +| Parameter | Type | Description | |
| 54 | +| --------- | ---- | ----------- | |
| 55 | +| `pdf` | file | Compiled PDF file | |
| 56 | +| `pdfUrl` | string | URL of the compiled PDF | |
| 57 | +| `fileName` | string | Name of the compiled PDF file | |
| 58 | +| `compiler` | string | LaTeX compiler used for the build | |
| 59 | + |
| 60 | +### `latex_search_packages` |
| 61 | + |
| 62 | +Search the TeX Live packages available to the LaTeX compiler by name or description, e.g. to check which packages can be used in a document. |
| 63 | + |
| 64 | +#### Input |
| 65 | + |
| 66 | +| Parameter | Type | Required | Description | |
| 67 | +| --------- | ---- | -------- | ----------- | |
| 68 | +| `query` | string | Yes | Search terms matched against package names and descriptions | |
| 69 | +| `maxResults` | number | No | Maximum number of packages to return \(default: 25, max: 100\) | |
| 70 | + |
| 71 | +#### Output |
| 72 | + |
| 73 | +| Parameter | Type | Description | |
| 74 | +| --------- | ---- | ----------- | |
| 75 | +| `packages` | array | TeX Live packages matching the query | |
| 76 | +| ↳ `name` | string | Package name | |
| 77 | +| ↳ `shortDescription` | string | One-line package description | |
| 78 | +| ↳ `installed` | boolean | Whether the package is installed | |
| 79 | +| ↳ `ctanUrl` | string | CTAN page for the package | |
| 80 | +| `totalMatches` | number | Total number of packages matching the query, before truncation | |
| 81 | + |
| 82 | +### `latex_get_package` |
| 83 | + |
| 84 | +Get details about a specific TeX Live package available to the LaTeX compiler, including whether it is installed, its description, license, and related packages. |
| 85 | + |
| 86 | +#### Input |
| 87 | + |
| 88 | +| Parameter | Type | Required | Description | |
| 89 | +| --------- | ---- | -------- | ----------- | |
| 90 | +| `name` | string | Yes | Exact package name, e.g. amsmath, tikz, or biblatex | |
| 91 | + |
| 92 | +#### Output |
| 93 | + |
| 94 | +| Parameter | Type | Description | |
| 95 | +| --------- | ---- | ----------- | |
| 96 | +| `package` | json | TeX Live package details | |
| 97 | +| ↳ `name` | string | Package name | |
| 98 | +| ↳ `installed` | boolean | Whether the package is installed | |
| 99 | +| ↳ `shortDescription` | string | One-line package description | |
| 100 | +| ↳ `longDescription` | string | Full package description | |
| 101 | +| ↳ `category` | string | Package category | |
| 102 | +| ↳ `license` | string | Package license identifier | |
| 103 | +| ↳ `topics` | array | CTAN topic tags | |
| 104 | +| ↳ `relatedPackages` | array | Names of related packages | |
| 105 | +| ↳ `homepage` | string | Package homepage URL | |
| 106 | +| ↳ `ctanUrl` | string | CTAN page for the package | |
| 107 | + |
| 108 | +### `latex_list_fonts` |
| 109 | + |
| 110 | +List the system fonts available to the LaTeX compiler, optionally filtered by name, e.g. to pick a font for xelatex or lualatex documents using fontspec. |
| 111 | + |
| 112 | +#### Input |
| 113 | + |
| 114 | +| Parameter | Type | Required | Description | |
| 115 | +| --------- | ---- | -------- | ----------- | |
| 116 | +| `query` | string | No | Filter matched against font family and full font name, e.g. "Noto Serif" | |
| 117 | +| `maxResults` | number | No | Maximum number of fonts to return \(default: 50, max: 200\) | |
| 118 | + |
| 119 | +#### Output |
| 120 | + |
| 121 | +| Parameter | Type | Description | |
| 122 | +| --------- | ---- | ----------- | |
| 123 | +| `fonts` | array | Fonts available to the LaTeX compiler | |
| 124 | +| ↳ `family` | string | Font family name | |
| 125 | +| ↳ `name` | string | Full font name | |
| 126 | +| ↳ `styles` | array | Available styles, e.g. Bold or Italic | |
| 127 | +| `totalMatches` | number | Total number of fonts matching the filter, before truncation | |
| 128 | + |
| 129 | + |
0 commit comments