Viridem icon

Viridem

Interact's with Viridem

Actions77

Annotations → Add Annotations Document Anchor

AI-generated

Overview

This node operation adds a document anchor with annotations to a specified company in the Viridem system. It is useful for scenarios where users need to attach annotated images or other content to documents within a company's records, such as marking up images or documents with additional information or highlights.

Use Case Examples

  1. Adding an image annotation to a document anchor for a specific company.
  2. Uploading base64-encoded images as annotations to a document anchor.

Properties

Name Meaning
Company Id The unique identifier of the company to which the document anchor belongs.
Document Anchor Id The unique identifier of the document anchor to which annotations will be added.
Use Defaults A boolean flag indicating whether to use default settings for the annotation addition.
Creator Name The name of the creator of the annotations, typically the user's full name or email.
Base 64 Urls A JSON array of base64-encoded image URLs to be added as annotations.
Annotations A JSON array of annotation objects containing content details such as content type and image attachment ID.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • response - The response from the Viridem API after adding the annotations document anchor.

Dependencies

  • Viridem API OAuth2 credentials for authentication

Troubleshooting

  • Ensure that the Company Id and Document Anchor Id are valid and exist in the Viridem system to avoid errors.
  • Verify that the base64 URLs and annotations JSON are correctly formatted to prevent parsing errors.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity issues.
  • Timeout errors can occur if the server takes too long to respond; adjust the timeout setting accordingly.

Discussion