Welcome to the TextWatermark API documentation. Our API allows you to embed and decode hidden watermarks within text content, providing a robust solution for tracking, authentication, and enhancing data integrity.
Core Concepts
Watermarking: The process of embedding imperceptible (or perceptible, if desired) data into a piece of text. This data, known as the "watermark payload," can be any information you wish to associate with the text, such as a user ID, document version, or timestamp.
Zero-Width Characters: We primarily utilize Unicode zero-width characters. These are special characters that do not take up any visual space and are typically invisible to the human eye. By strategically inserting these characters, we can encode binary data into your text without altering its appearance or layout.
Payload: The actual data you want to embed. This can be a simple string, a JSON object, or any other data format that can be represented as bits.
Encoding: The process of taking your input text and watermark payload, and producing a new version of the text that contains the embedded watermark.
Decoding: The process of extracting the hidden watermark payload from a piece of watermarked text.
Resilience: The ability of a watermark to survive various text manipulations, such as copy-pasting, format conversions (e.g., to PDF), or minor edits. Our techniques are designed for high resilience.
TextWatermark System Flow
The diagram above illustrates the core workflow of the TextWatermark system. It shows the process from the initial input of text, through the encoding/embedding of the watermark, to the final output of the watermarked text. It also depicts the reverse process of decoding/extracting the watermark to verify the text\'s authenticity or trace its origin.
API Philosophy
Our API is designed with the following principles in mind:
- Simplicity: Easy-to-understand endpoints and request/response structures.
- Precision: Mathematically sound encoding and decoding for reliability.
- Flexibility: Options to control watermark visibility and robustness.
- Developer-Friendly: Clear documentation, SDKs, and tools to help you integrate quickly.
This overview provides a starting point. Please explore the other sections of our documentation for detailed information on authentication, specific endpoints, error handling, and more.