Utilities

Read, write, or manage clipboard history

Action dispatcher for ToolPiper's managed clipboard history. Supported actions: read (most-recent item), write (text / image_base64 / file_paths), history (paginated list), get (single item by id), search (full-text), restore (re-copy item to NSPasteboard), pin / unpin, delete, clear. The clipboard manager polls NSPasteboard every 250 ms and captures items with OCR, source-app, and category metadata.

post/v1/clipboard

Request

  • Base URL: http://localhost:9998
  • URL: http://localhost:9998/v1/clipboard
  • Auth: HTTP bearer

Request body

action'read' | 'write' | 'history' | 'get' | 'search' | 'restore' | 'pin' | 'unpin' | 'delete' | 'clear' required
  • read — most-recent item.
  • write — set NSPasteboard from text, image_base64, or file_paths.
  • history — paginated history (limit, content_type, include_thumbnails, include_ocr).
  • get / restore / pin / unpin / delete — operate on item_id.
  • search — full-text query (query, limit, content_type, ...).
  • clear — wipe history.
textstring

Text payload for action=write.

image_base64string

Base64-encoded image (PNG/TIFF) for action=write.

file_pathsstring[]

Absolute file paths to copy as a file reference for action=write.

item_idstring

History item id for action=get|restore|pin|unpin|delete.

limitinteger

Max items to return for action=history|search. Default 20.

content_type'text' | 'image' | 'file'

Filter by content type for action=history|search.

include_thumbnailsboolean

Embed base64 thumbnails for image items. Default false.

include_ocrboolean

Include OCR text on image items. Default true.

querystring

Search query for action=search.

plain_text_onlyboolean

Restore as plain text (drop rich formatting). Default false. action=restore only.

Response

Action-specific response (shape varies by action)

object required

Shape depends on action. See ClipboardRequest for per-action semantics.

Changes

No recorded changes to this operation across all 1 revision of this API.