Office, Web & Archives

TypeScript SDK

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

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):

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.