Working with Annotation API

Introduction

GroupDocs.Annotation Cloud is a REST API that provides methods to apply Text and Figure based annotations to documents & images of all popular formats.

The difference between the V2 version from V1 is a more simplified API with fewer methods and options. Also, it has a more optimized and refined internal architecture. In this version, the API includes methods for working with cloud storage, which is an important part: main annotation API methods take input documents from storage and put results there.

Add Annotation

You can add arrow annotations to the supported document formats with request body parameters listed in AnnotationInfo).

Resource

The following GroupDocs.Annotation Cloud REST API resource has been used to get an annotation list from the document.

cURL REST Example

curl -X POST "https://api.groupdocs.cloud/v2.0/annotation?filePath#annotationdocs%2F" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]" -H  "Content-Type: application/json" -d "[  {    \"guid\": null,    \"documentGuid\": 0,    \"text\": null,    \"creatorGuid\": null,    \"creatorName\": \"Anonym A.\",    \"creatorEmail\": null,    \"box\": {      \"x\": 375.892761,      \"y\": 59.3882637,      \"width\": 88.7330551,      \"height\": 37.7290154    },    \"pageNumber\": 0,    \"annotationPosition\": {      \"x\": 852,      \"y\": 59.38826291079812    },    \"svgPath\": null,    \"type\": 1,    \"access\": null,    \"replies\": null,    \"createdOn\": \"0001-01-01T00:00:00\",    \"fontColor\": null,    \"penColor\": 1201033,    \"penWidth\": 1,    \"penStyle\": 0,    \"backgroundColor\": null,    \"fieldText\": null,    \"fontFamily\": null,    \"fontSize\": null,    \"opacity\": null,    \"angle\": null  }]"
code 200
Adds annotations to document

SDKs

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

Add Annotation

Delete Annotation

You can delete annotations to the supported document formats with request body parameters listed in AnnotationInfo).

Resource

The following GroupDocs.Annotation Cloud REST API resource has been used to Delete Annotation.

cURL REST Example

curl -X Delete "https://api.groupdocs.cloud/v2.0/annotation?filePath#annotationdocs%2Fone-page.docx" -H  "accept: application/json" -H  "authorization: Bearer [Access token]"
Http status code: 200  
<Binary file stream>

SDKs

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

Delete Annotation

Get Annotations with Result as File Path

This API gets an annotated document and retrieves the resultant document as a file.Request body parameters are  listed in AnnotationInfo).

Resource

The following GroupDocs.Annotation Cloud REST API resource has been used to get annotated documents as a file path.

cURL REST Example

curl -X DELETE "https://api.groupdocs.cloud/v2.0/annotation?filePath#viewerdocs%2Fone-page.docx" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]"
Http status code: 204

SDKs

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

Get Annotations with Result as File

Get Annotations with Result as Stream

This API gets an annotated document and retrieves the resultant document as a stream. The request body parameter is listed in AnnotationInfo).

Resource

The following GroupDocs.Annotation Cloud REST API resource has been used to get the annotated document as a stream.

cURL REST Example

curl -X DELETE "https://api.groupdocs.cloud/v2.0/annotation?filePath#viewerdocs%2Fone-page.docx" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]"
Http status code: 204

SDKs

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

Get Annotations with Result as Stream

Get Document as PDF with Annotation Result as Stream

This API gets an annotated PDF document and retrieves the resultant document as a stream.Request body parameters listed are in AnnotationInfo).

Resource

The following GroupDocs.Annotation Cloud REST API resource has been used to get resultant documents as PDF files.

cURL REST Example

curl -X DELETE "https://api.groupdocs.cloud/v2.0/annotation?filePath#viewerdocs%2Fone-page.docx" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]"
Http status code: 204

SDKs

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

Get Document as PDF with Annotation Result as Stream