Office, Web & Archives
Office, web, eBook, and archive conversion — REST and TypeScript SDK.
TypeScript SDK
| Module | SDK namespace |
|---|---|
| Office | ty.office |
| Web | ty.web |
| eBook | ty.ebook |
| Archive | ty.archive |
| File extract | ty.extract |
Slug xlsx-to-pdf → ty.office.xlsxToPdf({ file }). Full tables: SDK Tool Map.
import { ToolYour } from "@toolyour/sdk";
const ty = ToolYour({ apiKey: process.env.TOOLYOUR_API_KEY! });
await ty.office.xlsxToPdf({ file: xlsxBlob });
await ty.archive.zipToTar({ file: zipBlob });Send multipart/form-data with a file field unless noted.
Base paths
| Category | Base path |
|---|---|
| Office (XLS, PPT, ODF) | /api/v1/office/* |
| Web (HTML, XML, JSON, CSV) | /api/v1/web/* |
| eBook | /api/v1/ebook/* |
| Archive (ZIP, RAR, 7z, …) | /api/v1/archive/* |
Each module exposes GET …/supported-conversions without an API key to list available slugs.
File conversion routes in these modules return ToolFileResponse JSON with result.downloadUrl by default (same as Documents and Convertors). See Calling Tools.
File extract
POST /api/v1/extract accepts JSON:
{
"filename": "report.pdf",
"mimeType": "application/pdf",
"contentBase64": "..."
}Returns extracted text, segments, and metadata. Requires X-Api-Key.
AI models
These match the AI tools on toolyour.com (transcription, summarization, file analysis):
| Endpoint | Body |
|---|---|
POST /api/v1/ai-models/file-insights | multipart file + prompt + required geminiApiKey (or X-Gemini-Api-Key) |
POST /api/v1/ai-models/text-ai | JSON + required Gemini key |
POST /api/v1/ai-models/youtube-insight | JSON + required Gemini key |
Gemini-backed API routes (file-insights, text-ai, youtube-insight) do not use a platform Gemini key. Pass your own key from Google AI Studio. ToolYour credits are not charged for the Gemini call when the key is present. Max upload size is 10 MB. file-insights accepts PDF, DOC/DOCX, TXT, CSV/TSV, XLS/XLSX, common images, audio, and video.
Browser-only insight pages (page insight, landing teardown, GitHub repo insight, PDF Q&A, spreadsheet insight) are not REST, MCP, or SDK methods — use the tool page on toolyour.com.
All AI routes require X-Api-Key. The web UI also sends Turnstile headers; API-only clients should follow the same pattern if enforced by your deployment.
See the OpenAPI sidebar for every operation.