mirror of https://github.com/snapotter-hq/SnapOtter.git synced 2026-08-03 07:46:42 +02:00

Files

T

SnapOtterandGitHub ecc0a45f0e docs: per-tool reference pages for all 157 tools (+ fix docs build) (#261 )

* fix(docs): keep gray-matter on js-yaml 3 so the docs site builds

The js-yaml >=4.2.0 override from #257 forced js-yaml 4 onto gray-matter (used by vitepress and vitepress-plugin-llms), which calls the removed yaml.safeLoad and broke `vitepress build`. Scope a gray-matter>js-yaml ^3.14.1 override so gray-matter keeps the v3 API (build-time, trusted frontmatter only) while app code stays on js-yaml 4.2.0+.

* docs: add per-tool reference pages for all 157 tools, with a modality sidebar

Generate /tools/<id> pages for the 104 tools that lacked one (video 29, audio 17, document 36, data 10, and 12 newer image tools), matching the existing page format (API endpoint, parameters from the OpenAPI spec, curl example, response, notes). Async/AI tools document the 202+SSE flow and feature-bundle requirement.

Sidebar: add Video / Audio / PDF & Documents / Data groups with per-tool links, fold the 12 new image tools into the existing image categories, and replace the placeholder rest.md-anchor group. Docs site builds cleanly (157 pages, no dead links).

2026-06-17 11:11:37 +08:00

1.7 KiB

Raw Blame History

description

description
Read and write PDF document metadata.

PDF Metadata

Read and update PDF document metadata fields such as title, author, subject, and keywords. When no settings are provided, the existing metadata is returned without modification.

API Endpoint

POST /api/v1/tools/pdf-metadata

Accepts multipart form data with a PDF file and an optional JSON settings field.

Parameters

Parameter	Type	Required	Default	Description
title	string	No	-	Document title (max 500 characters)
author	string	No	-	Document author (max 500 characters)
subject	string	No	-	Document subject (max 500 characters)
keywords	string	No	-	Document keywords (max 500 characters)

All parameters are optional. Omitted fields are left unchanged.

Example Request

curl -X POST http://localhost:1349/api/v1/tools/pdf-metadata \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@report.pdf" \
  -F 'settings={"title": "Q2 Report", "author": "Finance Team"}'

Example Response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/report.pdf",
  "originalSize": 245000,
  "processedSize": 245200,
  "metadata": {
    "title": "Q2 Report",
    "author": "Finance Team",
    "subject": "",
    "keywords": ""
  }
}

Notes

Accepted input format: .pdf.
This is a fast (synchronous) tool that returns the result directly.
The metadata field in the response contains the resulting metadata after any updates.
To read metadata without modifying it, omit the settings field or send an empty object.
Each metadata field is limited to 500 characters.

1.7 KiB Raw Blame History