Document Annotation SDK for Ruby

Add Text, Area, Point, Polyline, Pointer, & Watermark Based Annotations to Documents of Various ‎Formats Using Ruby Applications.‎

Start Free Trial
GroupDocs.Annotation Cloud SDK for Ruby

GroupDocs.Annotation Cloud SDK for Ruby


The GroupDocs.Annotation Cloud for Ruby is a REST API that works as a document annotator and ‎supports lots of popular file formats for your business document and image annotation operations. ‎Through this set of APIs, Ruby developers can easily and efficiently create feature-rich online ‎document annotation tools. GroupDocs.Annotation Cloud SDK for Ruby is readily customizable to suit ‎your needs.‎

Previous Next

Advanced Document Annotation REST API Features



Support for Multiple File Formats


Import Annotation Information from Document & Return the List of Imported Annotations


Export/Add Annotation to a Document & Retrieve the Resultant Document as Stream


Render Document Pages to Images and Retrieve Images’ Links


Retrieve Link to Previously Generated Image by Page Number of Annotated Document


Render Document to PDF, Save Resultant Document to Storage & Fetch its Link


Render Document to PDF as an Output Stream


Add Text Redaction Annotation in Slides‎


Add Annotations to Header/Footer of Microsoft Word Documents


Easy Integration

GIntegrating GroupDocs.Annotation Cloud SDK into your ruby applications is very easy. No installation is ‎required on the server or client side. Just create an account at GroupDocs.CLOUD to get App SID & ‎key. Following example shows how easy it is to import annotation information using Ruby:‎

Import Annotation Information - Ruby

# TODO: Get your AppSID and AppKey at (free registration is required).
# For complete examples and data files, please go to
# Extracts annotations from document.
    def get_import
      @config =, Utils::APP_KEY)
      @config.api_base_url = Utils::API_BASE_URL
      @filename = 'Annotated.pdf'
      @foldername = nil      
      @annotation_api = GroupDocsAnnotationCloud::AnnotationApi.from_config(@config)     
      request =,@foldername)
# Extracts annotations from document.
      response = @annotation_api.get_import request
      puts response
      puts 'completed'

Support for Numerous Annotation Types

Using GroupDocs.Annotation Cloud SDK for Ruby, you can work with diverse types of annotations. The ‎two basic types are; Text Annotations and Figure Annotations.‎

While using text-based annotation, you can add text comments to selected text; highlight which text ‎should be replaced with what, hide confidential text using text redaction, highlight text with ‎strikethroughs/underlines, and add sticky notes with rich text.‎

While working with figure annotations, you can add notes to an area highlighted with a rectangle (Area ‎Annotation), add notes to any point in the document (Point Annotation), hide confidential parts of an ‎image or text (Area Redaction), draw freehand lines and shapes (Polyline), arrows pointing to an ‎object (Pointer/Arrow), create text-based watermark overlays (Watermark), and measure the ‎distance between any objects in a document (Distance Annotation).‎

Easy Customization

GroupDocs.Annotation Cloud SDK for Ruby is 100% tested and out of the box running. The SDK is open ‎source and has an MIT license. You can use it, and even customize it for absolutely free of charge.‎

Interactive API Explorer

Using our Swagger based API explorer; you can try out GroupDocs.Annotation Cloud SDK for Ruby ‎right away in your browser. This interactive API explorer gives you information about all the resources ‎that the API offers. You can also try your desired operation by interactively providing required ‎parameters.‎

Support and Learning Resources


GroupDocs.Annotation Cloud Product Family also includes SDKs for other popular languages as listed below: