cloudmersive-image-api-client

CloudmersiveImageApiClient - JavaScript client for cloudmersive-image-api-client Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations. Cloudmersive Image Recognition and Computer Vision API provides advanced computer vision and image recognition capabilities.

• API version: v1
• Package version: 1.3.5

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install cloudmersive-image-api-client --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your cloudmersive-image-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('cloudmersive-image-api-client') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var CloudmersiveImageApiClient = require('cloudmersive-image-api-client');

var defaultClient = CloudmersiveImageApiClient.ApiClient.instance;

// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix['Apikey'] = "Token"

var api = new CloudmersiveImageApiClient.ArtisticApi()

var style = "style_example"; // {String} The style of the painting to apply.  To start, try \"udnie\" a painting style.  Possible values are: \"udnie\", \"wave\", \"la_muse\", \"rain_princess\".

var imageFile = "/path/to/file.txt"; // {File} Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.artisticPainting(style, imageFile, callback);

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

Class	Method	HTTP request	Description
CloudmersiveImageApiClient.ArtisticApi	artisticPainting	POST /image/artistic/painting/{style}	Transform an image into an artistic painting automatically
CloudmersiveImageApiClient.ConvertApi	convertToBmp	POST /image/convert/to/bmp	Convert input image to Bitmap BMP format
CloudmersiveImageApiClient.ConvertApi	convertToGif	POST /image/convert/to/gif	Convert input image to GIF format
CloudmersiveImageApiClient.ConvertApi	convertToJpg	POST /image/convert/to/jpg/{quality}	Convert input image to JPG, JPEG format
CloudmersiveImageApiClient.ConvertApi	convertToPhotoshop	POST /image/convert/to/psd	Convert input image to Photoshop PSD format
CloudmersiveImageApiClient.ConvertApi	convertToPng	POST /image/convert/to/png	Convert input image to PNG format
CloudmersiveImageApiClient.ConvertApi	convertToTiff	POST /image/convert/to/tiff	Convert input image to TIFF format
CloudmersiveImageApiClient.ConvertApi	convertToWebP	POST /image/convert/to/webp	Convert input image to WebP format
CloudmersiveImageApiClient.EditApi	editAutoOrient	POST /image/edit/auto-orient/remove-exif	Normalizes image rotation and removes EXIF rotation data
CloudmersiveImageApiClient.EditApi	editCompositeBasic	POST /image/edit/composite/{location}	Composite two images together
CloudmersiveImageApiClient.EditApi	editCompositePrecise	POST /image/edit/composite/precise	Composite two images together precisely
CloudmersiveImageApiClient.EditApi	editContrastAdaptive	POST /image/edit/contrast/{gamma}/adaptive	Adaptively adjust the contrast of the image to be more appealing and easy to see
CloudmersiveImageApiClient.EditApi	editCropCircle	POST /image/edit/crop/circle/{left}/{top}/{radius}	Crop an image to an circular area
CloudmersiveImageApiClient.EditApi	editCropRectangle	POST /image/edit/crop/rectangle/{left}/{top}/{width}/{height}	Crop an image to a rectangular area
CloudmersiveImageApiClient.EditApi	editDrawPolygon	POST /image/edit/draw/polygon	Draw a polygon onto an image
CloudmersiveImageApiClient.EditApi	editDrawRectangle	POST /image/edit/draw/rectangle	Draw a rectangle onto an image
CloudmersiveImageApiClient.EditApi	editDrawText	POST /image/edit/draw/text	Draw text onto an image
CloudmersiveImageApiClient.EditApi	editDropShadow	POST /image/edit/drop-shadow/{X}/{Y}/{sigma}/{opacity}	Add a customizeable drop shadow to an image
CloudmersiveImageApiClient.EditApi	editInvert	POST /image/edit/invert	Invert, negate the colors in the image
CloudmersiveImageApiClient.EditApi	editRemoveExifData	POST /image/edit/remove-exif	Remove EXIF data from the image
CloudmersiveImageApiClient.EditApi	editRemoveTransparency	POST /image/edit/remove-transparency	Remove transparency from the image
CloudmersiveImageApiClient.EditApi	editRotate	POST /image/edit/rotate/{degrees}/angle	Rotate an image any number of degrees
CloudmersiveImageApiClient.FaceApi	faceCompare	POST /image/face/compare-and-match	Compare and match faces
CloudmersiveImageApiClient.FaceApi	faceCropFirst	POST /image/face/crop/first	Crop image to face with square crop
CloudmersiveImageApiClient.FaceApi	faceCropFirstRound	POST /image/face/crop/first/round	Crop image to face with round crop
CloudmersiveImageApiClient.FaceApi	faceDetectAge	POST /image/face/detect-age	Detect the age of people in an image
CloudmersiveImageApiClient.FaceApi	faceDetectGender	POST /image/face/detect-gender	Detect the gender of people in an image
CloudmersiveImageApiClient.FaceApi	faceLocate	POST /image/face/locate	Detect and find faces in an image
CloudmersiveImageApiClient.FaceApi	faceLocateWithLandmarks	POST /image/face/locate-with-landmarks	Detect and find faces and landmarks eyes and nose and mouth in image
CloudmersiveImageApiClient.FilterApi	filterBlackAndWhite	POST /image/filter/black-and-white	Convert image to black-and-white grayscale
CloudmersiveImageApiClient.FilterApi	filterDespeckle	POST /image/filter/despeckle	Despeckle to remove point noise from the image
CloudmersiveImageApiClient.FilterApi	filterEdgeDetect	POST /image/filter/edge-detect/{radius}	Detect and highlight edges in an image
CloudmersiveImageApiClient.FilterApi	filterEmboss	POST /image/filter/emboss/{radius}/{sigma}	Emboss an image
CloudmersiveImageApiClient.FilterApi	filterGaussianBlur	POST /image/filter/blur/guassian/{radius}/{sigma}	Perform a guassian blur on the input image
CloudmersiveImageApiClient.FilterApi	filterMotionBlur	POST /image/filter/blur/motion/{radius}/{sigma}/{angle}	Perform a motion blur on the input image
CloudmersiveImageApiClient.FilterApi	filterPosterize	POST /image/filter/posterize	Posterize the image by reducing distinct colors
CloudmersiveImageApiClient.FilterApi	filterSwirl	POST /image/filter/swirl	Swirl distort the image
CloudmersiveImageApiClient.InfoApi	infoGetDominantColor	POST /image/get-info/dominant-color	Returns the dominant colors of the image
CloudmersiveImageApiClient.InfoApi	infoGetMetadata	POST /image/get-info/metadata	Returns the image metadata including EXIF and resolution
CloudmersiveImageApiClient.NsfwApi	nsfwClassify	POST /image/nsfw/classify	Not safe for work NSFW racy content classification
CloudmersiveImageApiClient.RecognizeApi	recognizeDescribe	POST /image/recognize/describe	Describe an image in natural language
CloudmersiveImageApiClient.RecognizeApi	recognizeDetectAndUnskewDocument	POST /image/recognize/detect-document/unskew	Detect and unskew a photo of a document
CloudmersiveImageApiClient.RecognizeApi	recognizeDetectObjects	POST /image/recognize/detect-objects	Detect objects including types and locations in an image
CloudmersiveImageApiClient.RecognizeApi	recognizeDetectPeople	POST /image/recognize/detect-people	Detect people including locations in an image
CloudmersiveImageApiClient.RecognizeApi	recognizeDetectTextFine	POST /image/recognize/detect-text/fine	Detect fine text in a photo of a document
CloudmersiveImageApiClient.RecognizeApi	recognizeDetectTextLarge	POST /image/recognize/detect-text/large	Detect large text in a photo
CloudmersiveImageApiClient.RecognizeApi	recognizeDetectVehicleLicensePlates	POST /image/recognize/detect-vehicle-license-plates	Detect vehicle license plates in an image
CloudmersiveImageApiClient.RecognizeApi	recognizeFindSymbol	POST /image/recognize/find/symbol	Find the location of a symbol in an image
CloudmersiveImageApiClient.RecognizeApi	recognizeSimilarityCompare	POST /image/recognize/similarity/compare	Compare two images for similarity
CloudmersiveImageApiClient.RecognizeApi	recognizeSimilarityHash	POST /image/recognize/similarity/hash	Generate a perceptual image hash
CloudmersiveImageApiClient.RecognizeApi	recognizeSimilarityHashDistance	POST /image/recognize/similarity/hash/distance	Calculates the similarity between two perceptual image hashes
CloudmersiveImageApiClient.ResizeApi	resizePost	POST /image/resize/preserveAspectRatio/{maxWidth}/{maxHeight}	Resize an image while preserving aspect ratio
CloudmersiveImageApiClient.ResizeApi	resizeResizeSimple	POST /image/resize/target/{width}/{height}	Resize an image
CloudmersiveImageApiClient.TextGenerationApi	textGenerationCreateHandwritingPng	POST /image/text/create/handwriting/png	Create an image of handwriting in PNG format

Documentation for Models

• CloudmersiveImageApiClient.AgeDetectionResult
• CloudmersiveImageApiClient.ColorResult
• CloudmersiveImageApiClient.CreateHandwritingRequest
• CloudmersiveImageApiClient.DetectedLicensePlate
• CloudmersiveImageApiClient.DetectedObject
• CloudmersiveImageApiClient.DominantColorResult
• CloudmersiveImageApiClient.DrawPolygonInstance
• CloudmersiveImageApiClient.DrawPolygonRequest
• CloudmersiveImageApiClient.DrawRectangleInstance
• CloudmersiveImageApiClient.DrawRectangleRequest
• CloudmersiveImageApiClient.DrawTextInstance
• CloudmersiveImageApiClient.DrawTextRequest
• CloudmersiveImageApiClient.Face
• CloudmersiveImageApiClient.FaceCompareResponse
• CloudmersiveImageApiClient.FaceLocateResponse
• CloudmersiveImageApiClient.FaceLocateWithLandmarksResponse
• CloudmersiveImageApiClient.FaceMatch
• CloudmersiveImageApiClient.FacePoint
• CloudmersiveImageApiClient.FaceWithLandmarks
• CloudmersiveImageApiClient.FindSymbolResult
• CloudmersiveImageApiClient.FineTextDetectionResult
• CloudmersiveImageApiClient.FineTextItem
• CloudmersiveImageApiClient.GenderDetectionResult
• CloudmersiveImageApiClient.ImageDescriptionResponse
• CloudmersiveImageApiClient.ImageMetadata
• CloudmersiveImageApiClient.ImageMetadataExifValue
• CloudmersiveImageApiClient.ImageSimilarityComparisonResponse
• CloudmersiveImageApiClient.ImageSimilarityHashDistanceRequest
• CloudmersiveImageApiClient.ImageSimilarityHashDistanceResponse
• CloudmersiveImageApiClient.ImageSimilarityHashResponse
• CloudmersiveImageApiClient.NsfwResult
• CloudmersiveImageApiClient.ObjectDetectionResult
• CloudmersiveImageApiClient.PersonWithAge
• CloudmersiveImageApiClient.PersonWithGender
• CloudmersiveImageApiClient.PolygonPoint
• CloudmersiveImageApiClient.RecognitionOutcome
• CloudmersiveImageApiClient.TextDetectionResult
• CloudmersiveImageApiClient.TextItem
• CloudmersiveImageApiClient.VehicleLicensePlateDetectionResult

Documentation for Authorization

Apikey

• Type: API key
• API key parameter name: Apikey
• Location: HTTP header