Partager via


Cloudmersive Image Processing

Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
URL https://account.cloudmersive.com/contact-support
Connector Metadata
Publisher Cloudmersive, LLC
Website https://cloudmersive.com/image-recognition-and-processing-api
Privacy policy https://cloudmersive.com/privacy-policy

This connector is critical for any image processing application to process images (including Crop, Composite, Layering, Filtering, and more), Deep Learning recognition of images, including people, faces, objects and more in images, and converting image files between formats at very high fidelity. Cloudmersive Image Processing covers a wide array of common file formats, including PNG, BMP, JPEG, WEBP, PSD and over 100 other file formats. Stateless high-security and high-performance processing ensures fast performance and strong security. You can learn more at the Image Recognition and Processing API page.

To use this connector, you need a Cloudmersive account. You can sign up with a Microsoft Account or create a Cloudmersive account. Follow the steps below to get your API Key.

Get the API Key and Secret

  • Register for a Cloudmersive Account
  • Sign In with your Cloudmersive Account and click on API Keys

Here you can create and see your API key(s) listed on the API Keys page. Simply copy and paste this API Key into the Cloudmersive Image Processing Connector.

Now you are ready to start using the Cloudmersive Image Processing Connector.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key (from https://cloudmersive.com) securestring The Api Key for this API True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Adaptively adjust the contrast of the image to be more appealing and easy to see

Uses Gamma to adjust the contrast adaptively the way the human eye sees the world. Results significantly improve the viewability and visual appeal of the image.

Add a customizeable drop shadow to an image

Add a customizeable drop shadow to the image

Compare and match faces

Find the faces in an input image, and compare against a reference image to determine if there is a match against the face in the reference image. The reference image (second parameter) should contain exactly one face.

Composite two images together

Composites two input images together; a layered image onto a base image. The first image you input is the base image. The second image (the layered image) will be composited on top of this base image. Supports PNG transparency. To control padding you can include transparent pixels at the border(s) of your layered images as appropriate.

Convert image to black-and-white grayscale

Remove color from the image by converting to a grayscale, black-and-white image

Convert input image to Bitmap BMP format

Converts the input image into PSD format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Convert input image to GIF format

Converts the input image into GIF format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Convert input image to JPG, JPEG format

Converts the input image into JPEG/JPG format. Customize encoding parameters. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Convert input image to Photoshop PSD format

Converts the input image into PSD format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Convert input image to PNG format

Converts the input image into PNG format. Transparency is preserved when present. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Convert input image to TIFF format

Converts the input image into TIFF format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Convert input image to WebP format

Converts the input image into WebP format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Crop an image to a rectangular area

Crop an image to a target rectangular area

Crop image to face with round crop

Crop an image to the face (circular/round crop). If there is more than one face present, choose the first one.

Crop image to face with square crop

Crop an image to the face (rectangular crop). If there is more than one face present, choose the first one.

Describe an image in natural language

Generate an English language text description of the image as a sentence.

Despeckle to remove point noise from the image

Remove point noise / despeckle the input image

Detect and find faces and landmarks eyes and nose and mouth in image

Locate the positions of all faces in an image, along with the eyes, eye brows, nose and mouth components of each

Detect and find faces in an image

Locate the positions of all faces in an image

Detect and highlight edges in an image

Perform an edge detection operation on the input image

Detect and unskew a photo of a document

Detect and unskew a photo of a document (e.g. taken on a cell phone) into a perfectly square image. Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.

Detect fine text in a photo of a document

Identify the position, and size of small/fine text within a photograph of a document. Identify the location of small text in a photo - such as words and other forms of high density text. Can be used on a scan of a document or a photograph (e.g. smartphone camera) of a document, page or receipt. For OCR purposes - please see our Deep Learning OCR APIs.

Detect large text in a photo

Identify the position, and size of large text within a photograph. Identify the location of large text in a photo - such as signs, titles, etc. and other forms of large, low-density text. Not suitable for high-density text (e.g. scans of documents, receipts, etc.) for OCR purposes - for OCR, please see our Deep Learning OCR APIs.

Detect objects including types and locations in an image

Identify the position, size and description of objects in an image, along with a recognition confidence level. Detects both human people and objects in an image.

Detect people including locations in an image

Identify the position, and size of human people in an image, along with a recognition confidence level. People in the image do NOT need to be facing the camera; they can be facing away, edge-on, etc.

Detect the age of people in an image

Identify the age, position, and size of human faces in an image, along with a recognition confidence level. People in the image do NOT need to be facing the camera; they can be facing away, edge-on, etc.

Detect the gender of people in an image

Identify the gender, position, and size of human faces in an image, along with a recognition confidence level. People in the image should be facing the camera.

Detect vehicle license plates in an image

Identify the position, and size, and content of vehicle license plates in an image. License plates should be within 15-20 degrees on-axis to the camera.

Draw a polygon onto an image

Draw one or more polygons, with customized visuals, onto an image

Draw a rectangle onto an image

Draw one or more rectangles, with customized visuals, onto an image

Draw text onto an image

Draw one or more pieces of text, with customized visuals, onto an image

Emboss an image

Perform an emboss operation on the input image

Find the location of a symbol in an image

Determine if an image contains a symbol, and if so, the location of that symbol in the image.

Normalizes image rotation and removes EXIF rotation data

Automatically orients the input image based on EXIF information and then removes the EXIF information. EXIF is an additional set of information stored in some images taken with cell phone cameras based on the orientation of the camera. By normalizing rotation and removing EXIF data these images become much easier to process.

Not safe for work NSFW racy content classification

Classify an image into Not Safe For Work (NSFW)/Porn/Racy content and Safe Content.

Perform a guassian blur on the input image

Perform a gaussian blur on the input image

Perform a motion blur on the input image

Perform a motion blur on the input image at a specific angle

Posterize the image by reducing distinct colors

Reduce the unique number of colors in the image to the specified level

Remove transparency from the image

Removes any active transparency in the image. Effectively renders the image at the same resolution, in the same file format, over a white background, thus removing transparency.

Resize an image

Resize an image to a specific width and specific height

Resize an image while preserving aspect ratio

Resize an image to a maximum width and maximum height, while preserving the image's original aspect ratio

Returns the dominant colors of the image

Uses advanced image processing to extract the top 5 dominant colors in the image, returned in the order of dominance with the most-dominant color first. These are the primary perceptual colors used in the image as perceived by a viewer.

Returns the image metadata including EXIF and resolution

Returns the metadata information on the image, including file type, EXIF (if available), and resolution.

Rotate an image any number of degrees

Rotates an image by an arbitrary number of degrees

Swirl distort the image

Swirl distort the image by the specified number of degrees

Transform an image into an artistic painting automatically

Uses machine learning to automatically transform an image into an artistic painting. Due to depth of AI processing, depending on image size this operation can take up to 20 seconds.

Adaptively adjust the contrast of the image to be more appealing and easy to see

Uses Gamma to adjust the contrast adaptively the way the human eye sees the world. Results significantly improve the viewability and visual appeal of the image.

Parameters

Name Key Required Type Description
Gamma value to adjust the contrast in the image. Recommended value is...
gamma True double

Gamma value to adjust the contrast in the image. Recommended value is...

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Add a customizeable drop shadow to an image

Add a customizeable drop shadow to the image

Parameters

Name Key Required Type Description
Horizontal (X) offset of the drop shadow
X True integer

Horizontal (X) offset of the drop shadow

Vertical (Y) offset of the drop shadow
Y True integer

Vertical (Y) offset of the drop shadow

Sigma (blur distance) of the drop shadow
sigma True integer

Sigma (blur distance) of the drop shadow

Opacity of the drop shadow; 0 is 0% and 100 is 100%
opacity True integer

Opacity of the drop shadow; 0 is 0% and 100 is 100%

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Compare and match faces

Find the faces in an input image, and compare against a reference image to determine if there is a match against the face in the reference image. The reference image (second parameter) should contain exactly one face.

Parameters

Name Key Required Type Description
Image file to perform the operation on; this image can contain one or ...
inputImage True file

Image file to perform the operation on; this image can contain one or ...

Image of a single face to compare and match against.
matchFace True file

Image of a single face to compare and match against.

Returns

Results of comparing/matching faces in an image

Composite two images together

Composites two input images together; a layered image onto a base image. The first image you input is the base image. The second image (the layered image) will be composited on top of this base image. Supports PNG transparency. To control padding you can include transparent pixels at the border(s) of your layered images as appropriate.

Parameters

Name Key Required Type Description
Location to composite the layered images; possible values are: "center...
location True string

Location to composite the layered images; possible values are: "center...

Image file to perform the operation on. Common file formats such as P...
baseImage True file

Image file to perform the operation on. Common file formats such as P...

Image to layer on top of the base image.
layeredImage True file

Image to layer on top of the base image.

Returns

response
binary

Convert image to black-and-white grayscale

Remove color from the image by converting to a grayscale, black-and-white image

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Convert input image to Bitmap BMP format

Converts the input image into PSD format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Convert input image to GIF format

Converts the input image into GIF format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Convert input image to JPG, JPEG format

Converts the input image into JPEG/JPG format. Customize encoding parameters. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Parameters

Name Key Required Type Description
Set the JPEG quality level; lowest quality is 1 (highest compression),...
quality True integer

Set the JPEG quality level; lowest quality is 1 (highest compression),...

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Convert input image to Photoshop PSD format

Converts the input image into PSD format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Convert input image to PNG format

Converts the input image into PNG format. Transparency is preserved when present. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Convert input image to TIFF format

Converts the input image into TIFF format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Convert input image to WebP format

Converts the input image into WebP format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Crop an image to a rectangular area

Crop an image to a target rectangular area

Parameters

Name Key Required Type Description
The left edge of the rectangular crop area in pixels (X).
left True integer

The left edge of the rectangular crop area in pixels (X).

The top edge of the rectangular crop area in pixels (Y).
top True integer

The top edge of the rectangular crop area in pixels (Y).

The width of the rectangular crop area in pixels.
width True integer

The width of the rectangular crop area in pixels.

The height of the rectangular crop area in pixels.
height True integer

The height of the rectangular crop area in pixels.

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Crop image to face with round crop

Crop an image to the face (circular/round crop). If there is more than one face present, choose the first one.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Crop image to face with square crop

Crop an image to the face (rectangular crop). If there is more than one face present, choose the first one.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Describe an image in natural language

Generate an English language text description of the image as a sentence.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

Result of recognizing an image

Despeckle to remove point noise from the image

Remove point noise / despeckle the input image

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Detect and find faces and landmarks eyes and nose and mouth in image

Locate the positions of all faces in an image, along with the eyes, eye brows, nose and mouth components of each

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

Results of locating faces in an image

Detect and find faces in an image

Locate the positions of all faces in an image

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

Results of locating faces in an image

Detect and highlight edges in an image

Perform an edge detection operation on the input image

Parameters

Name Key Required Type Description
Radius in pixels of the edge detection operation; a larger radius will...
radius True integer

Radius in pixels of the edge detection operation; a larger radius will...

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Detect and unskew a photo of a document

Detect and unskew a photo of a document (e.g. taken on a cell phone) into a perfectly square image. Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Optional, post-processing effects to apply to the email, default is No...
PostProcessingEffect string

Optional, post-processing effects to apply to the email, default is No...

Returns

response
binary

Detect fine text in a photo of a document

Identify the position, and size of small/fine text within a photograph of a document. Identify the location of small text in a photo - such as words and other forms of high density text. Can be used on a scan of a document or a photograph (e.g. smartphone camera) of a document, page or receipt. For OCR purposes - please see our Deep Learning OCR APIs.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

Result of an operation to detect text in a photo

Detect large text in a photo

Identify the position, and size of large text within a photograph. Identify the location of large text in a photo - such as signs, titles, etc. and other forms of large, low-density text. Not suitable for high-density text (e.g. scans of documents, receipts, etc.) for OCR purposes - for OCR, please see our Deep Learning OCR APIs.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

Result of an operation to detect text in a photo

Detect objects including types and locations in an image

Identify the position, size and description of objects in an image, along with a recognition confidence level. Detects both human people and objects in an image.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

Result of detecting objects in an image

Detect people including locations in an image

Identify the position, and size of human people in an image, along with a recognition confidence level. People in the image do NOT need to be facing the camera; they can be facing away, edge-on, etc.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

Result of detecting objects in an image

Detect the age of people in an image

Identify the age, position, and size of human faces in an image, along with a recognition confidence level. People in the image do NOT need to be facing the camera; they can be facing away, edge-on, etc.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

Result from classifying the Age of people in an image

Detect the gender of people in an image

Identify the gender, position, and size of human faces in an image, along with a recognition confidence level. People in the image should be facing the camera.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

Result from classifying the Gender of people in an image

Detect vehicle license plates in an image

Identify the position, and size, and content of vehicle license plates in an image. License plates should be within 15-20 degrees on-axis to the camera.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

Result of detecting vehicle license plates in an image

Draw a polygon onto an image

Draw one or more polygons, with customized visuals, onto an image

Parameters

Name Key Required Type Description
BaseImageBytes
BaseImageBytes byte

Image to draw polygons on, in bytes. You can also use the BaseImageUrl instead to supply image input as a URL

BaseImageUrl
BaseImageUrl string

Image to draw polygons on, as an HTTP or HTTPS fully-qualified URL

BorderColor
BorderColor string

Border Color to use - can be a hex value (with #) or HTML common color name. Transparent colors are supported.

BorderWidth
BorderWidth double

Width in pixels of the border. Pass in 0 to draw a polygon with no border

FillColor
FillColor string

Fill Color to use - can be a hex value (with #) or HTML common color name. Transparent colors are supported. Leave blank to not fill the polygon.

X
X double

X location in pixels of this point in the polygon

Y
Y double

Y location in pixels of this point in the polygon

Returns

response
binary

Draw a rectangle onto an image

Draw one or more rectangles, with customized visuals, onto an image

Parameters

Name Key Required Type Description
BaseImageBytes
BaseImageBytes byte

Image to draw rectangles on, in bytes. You can also use the BaseImageUrl instead to supply image input as a URL

BaseImageUrl
BaseImageUrl string

Image to draw rectangles on, as an HTTP or HTTPS fully-qualified URL

BorderColor
BorderColor string

Border Color to use - can be a hex value (with #) or HTML common color name. Transparent colors are supported.

BorderWidth
BorderWidth double

Width in pixels of the border. Pass in 0 to draw a rectangle with no border

FillColor
FillColor string

Fill Color to use - can be a hex value (with #) or HTML common color name. Transparent colors are supported. Leave blank to not fill the rectangle.

Height
Height double

Height in pixels of the rectangle

Width
Width double

Width in pixels of the rectangle

X
X double

Pixel location of the left edge of the rectangle location

Y
Y double

Pixel location of the top edge of the rectangle location

Returns

response
binary

Draw text onto an image

Draw one or more pieces of text, with customized visuals, onto an image

Parameters

Name Key Required Type Description
BaseImageBytes
BaseImageBytes byte

Image to draw text on, in bytes. You can also use the BaseImageUrl instead to supply image input as a URL

BaseImageUrl
BaseImageUrl string

Image to draw text on, as an HTTP or HTTPS fully-qualified URL

Color
Color string

Color to use - can be a hex value (with #) or HTML common color name

FontFamilyName
FontFamilyName string

Font Family to use. Leave blank to default to "Arial".

FontSize
FontSize double

Font size to use.

Height
Height double

Height in pixels of the text box to draw the text in; text will wrap inside this box

Text
Text string

Text string to draw

Width
Width double

Width in pixels of the text box to draw the text in; text will wrap inside this box

X
X double

Pixel location of the left edge of the text location

Y
Y double

Pixel location of the top edge of the text location

Returns

response
binary

Emboss an image

Perform an emboss operation on the input image

Parameters

Name Key Required Type Description
Radius in pixels of the emboss operation; a larger radius will produce...
radius True integer

Radius in pixels of the emboss operation; a larger radius will produce...

Sigma, or variance, of the emboss operation
sigma True integer

Sigma, or variance, of the emboss operation

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Find the location of a symbol in an image

Determine if an image contains a symbol, and if so, the location of that symbol in the image.

Parameters

Name Key Required Type Description
Image file to search through for the target image.
inputImage True file

Image file to search through for the target image.

Image to find in the input image.
targetImage True file

Image to find in the input image.

Returns

Result of a find symbol operation on an input image

Normalizes image rotation and removes EXIF rotation data

Automatically orients the input image based on EXIF information and then removes the EXIF information. EXIF is an additional set of information stored in some images taken with cell phone cameras based on the orientation of the camera. By normalizing rotation and removing EXIF data these images become much easier to process.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Not safe for work NSFW racy content classification

Classify an image into Not Safe For Work (NSFW)/Porn/Racy content and Safe Content.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

Result of an NSFW classification

Body
NsfwResult

Perform a guassian blur on the input image

Perform a gaussian blur on the input image

Parameters

Name Key Required Type Description
Radius in pixels of the blur operation; a larger radius will produce a...
radius True integer

Radius in pixels of the blur operation; a larger radius will produce a...

Sigma, or variance, of the gaussian blur operation
sigma True integer

Sigma, or variance, of the gaussian blur operation

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Perform a motion blur on the input image

Perform a motion blur on the input image at a specific angle

Parameters

Name Key Required Type Description
Radius in pixels of the blur operation; a larger radius will produce a...
radius True integer

Radius in pixels of the blur operation; a larger radius will produce a...

Sigma, or variance, of the motion blur operation
sigma True integer

Sigma, or variance, of the motion blur operation

Angle of the motion blur in degrees
angle True integer

Angle of the motion blur in degrees

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Posterize the image by reducing distinct colors

Reduce the unique number of colors in the image to the specified level

Parameters

Name Key Required Type Description
Number of unique colors to retain in the output image
levels True integer

Number of unique colors to retain in the output image

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Remove transparency from the image

Removes any active transparency in the image. Effectively renders the image at the same resolution, in the same file format, over a white background, thus removing transparency.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Resize an image

Resize an image to a specific width and specific height

Parameters

Name Key Required Type Description
Width of the output image - final image will be exactly this width
width True integer

Width of the output image - final image will be exactly this width

Height of the output image - final image will be exactly this height
height True integer

Height of the output image - final image will be exactly this height

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Resize an image while preserving aspect ratio

Resize an image to a maximum width and maximum height, while preserving the image's original aspect ratio

Parameters

Name Key Required Type Description
Maximum width of the output image - final image will be as large as po...
maxWidth True integer

Maximum width of the output image - final image will be as large as po...

Maximum height of the output image - final image will be as large as p...
maxHeight True integer

Maximum height of the output image - final image will be as large as p...

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Returns the dominant colors of the image

Uses advanced image processing to extract the top 5 dominant colors in the image, returned in the order of dominance with the most-dominant color first. These are the primary perceptual colors used in the image as perceived by a viewer.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

Result of performing a get dominant color operation

Returns the image metadata including EXIF and resolution

Returns the metadata information on the image, including file type, EXIF (if available), and resolution.

Parameters

Name Key Required Type Description
Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

Metadata from an image

Rotate an image any number of degrees

Rotates an image by an arbitrary number of degrees

Parameters

Name Key Required Type Description
Degrees to rotate the image; values range from 0.0 to 360.0.
degrees True double

Degrees to rotate the image; values range from 0.0 to 360.0.

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Swirl distort the image

Swirl distort the image by the specified number of degrees

Parameters

Name Key Required Type Description
Degrees of swirl
degrees True integer

Degrees of swirl

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Transform an image into an artistic painting automatically

Uses machine learning to automatically transform an image into an artistic painting. Due to depth of AI processing, depending on image size this operation can take up to 20 seconds.

Parameters

Name Key Required Type Description
The style of the painting to apply. To start, try "udnie" a painting ...
style True string

The style of the painting to apply. To start, try "udnie" a painting ...

Image file to perform the operation on. Common file formats such as P...
imageFile True file

Image file to perform the operation on. Common file formats such as P...

Returns

response
binary

Definitions

AgeDetectionResult

Result from classifying the Age of people in an image

Name Path Type Description
PeopleIdentified
PeopleIdentified integer

Number of people identified in the image with an age

PeopleWithAge
PeopleWithAge array of PersonWithAge

People in the image annotated with age information

Successful
Successful boolean

True if the operation was successful, false otherwise

ColorResult

Individual color

Name Path Type Description
B
B integer

Blue (B) channel pixel value of this color

G
G integer

Green (G) channel pixel value of this color

R
R integer

Red (R) channel pixel value of this color

DetectedLicensePlate

License plate found in the image

Name Path Type Description
Height
Height integer

Height of the license plate's location in pixels

LicensePlateRecognitionConfidenceLevel
LicensePlateRecognitionConfidenceLevel double

Confidence score on a range of 0.0 - 1.0 of the accuracy of the detected license plate, with higher scores being better; values about 0.75 are high confidence

LicensePlateText_BestMatch
LicensePlateText_BestMatch string

Text from the license plate, highest-confidence result

LicensePlateText_RunnerUp
LicensePlateText_RunnerUp string

Alternate text from the license plate, based on second-highest-confidence result

LocationX
LocationX integer

X location of the left edge of the license plate, starting from the left edge of the photo (X = 0)

LocationY
LocationY integer

Y location of the top edge of the license plate, starting from the top edge of the photo (Y = 0)

Width
Width integer

Width of the license plate's location in pixels

DetectedObject

Single object instance, and associated details, detected in an image

Name Path Type Description
Height
Height integer

Height, in pixels, of the object

ObjectClassName
ObjectClassName string

Class of the object. Example values are "person", "car", "dining table", etc.

Score
Score double

Confidence score of detected object; possible values are between 0.0 and 1.0; values closer to 1.0 are higher confidence

Width
Width integer

Width, in pixels, of the object

X
X integer

X location, in pixels, of the left side location of the object, with the right side being X + Width

Y
Y integer

Y location, in pixels, of the top side location of the object, with the bottom side being Y + Height

DominantColorResult

Result of performing a get dominant color operation

Name Path Type Description
DominantColors
DominantColors array of ColorResult

Dominant colors in the image, in order where most dominant color is in the first index position (0), the second most-dominant color is in index position 1 and so on

Successful
Successful boolean

True if the operation was successful, false otherwise

Face

Location of one face in an image

Name Path Type Description
BottomY
BottomY integer

Y coordinate of the bottom side of the face

LeftX
LeftX integer

X coordinate of the left side of the face

RightX
RightX integer

X coordinate of the right side of the face

TopY
TopY integer

Y coordinate of the top side of the face

FaceCompareResponse

Results of comparing/matching faces in an image

Name Path Type Description
ErrorDetails
ErrorDetails string

Details of any errors that occurred

FaceCount
FaceCount integer

Number of faces found in the image

Faces
Faces array of FaceMatch

Array of faces found in the input image

Successful
Successful boolean

True if the operation was successful, false otherwise

FaceLocateResponse

Results of locating faces in an image

Name Path Type Description
ErrorDetails
ErrorDetails string

Details of any errors that occurred

FaceCount
FaceCount integer

Number of faces found in the image

Faces
Faces array of Face

Array of faces found in the image

Successful
Successful boolean

True if the operation was successful, false otherwise

FaceLocateWithLandmarksResponse

Results of locating faces in an image

Name Path Type Description
ErrorDetails
ErrorDetails string

Details of any errors that occurred

FaceCount
FaceCount integer

Number of faces found in the image

Faces
Faces array of FaceWithLandmarks

Array of faces found in the image

Successful
Successful boolean

True if the operation was successful, false otherwise

FaceMatch

Location of one face in an image, along with match results

Name Path Type Description
BottomY
BottomY integer

Y coordinate of the bottom side of the face

HighConfidenceMatch
HighConfidenceMatch boolean

True if there is a high confidence match, false otherwise

LeftX
LeftX integer

X coordinate of the left side of the face

MatchScore
MatchScore double

Match score from 0.0 to 1.0 with higher scores indicating a greater match; scores above 0.7 indicate a match

RightX
RightX integer

X coordinate of the right side of the face

TopY
TopY integer

Y coordinate of the top side of the face

FacePoint

Point location within a face

Name Path Type Description
X
X integer

X location, where 0 is the left-most pixel

Y
Y integer

Y location, where 0 is the top-most pixel

FaceWithLandmarks

Location of one face in an image

Name Path Type Description
BottomAndSidesOfFace
BottomAndSidesOfFace array of FacePoint

Point locations of the bottom and sides of the face (cheeks and chin)

BottomY
BottomY integer

Y coordinate of the bottom side of the face

LeftEye
LeftEye array of FacePoint

Point locations of the left eye (the eye closest to the left side of the picture)

LeftEyebrow
LeftEyebrow array of FacePoint

Point locations of the left eyebrow (the eyebrow cloesest to the left side of the picture)

LeftX
LeftX integer

X coordinate of the left side of the face

LipsInnerOutline
LipsInnerOutline array of FacePoint

Point locations of the inner outline of the lips

LipsOuterOutline
LipsOuterOutline array of FacePoint

Point locations of the outer outline of the lips

NoseBottom
NoseBottom array of FacePoint

Point locations of the bottom (nostrils) of the nose

NoseBridge
NoseBridge array of FacePoint

Point locations of the nose bridge (the vertical portion of the nose)

RightEye
RightEye array of FacePoint

Point locations of the right eye (the eye closest to the right side of the picture)

RightEyebrow
RightEyebrow array of FacePoint

Point locations of the right eyebrow (the eyebrow cloesest to the right side of the picture)

RightX
RightX integer

X coordinate of the right side of the face

TopY
TopY integer

Y coordinate of the top side of the face

FindSymbolResult

Result of a find symbol operation on an input image

Name Path Type Description
Height
Height integer

Height of the found location in pixels

MatchScore
MatchScore double

Score between 0.0 and 1.0 that measures how closely the symbol matched; scores above 0.2 are good

Successful
Successful boolean

True if successful, false otherwise

Width
Width integer

Width of the found location in pixels

XLeft
XLeft integer

X location of the left edge of the found location in pixels

YTop
YTop integer

Y location of the top edge of the found location in pixels

FineTextDetectionResult

Result of an operation to detect text in a photo

Name Path Type Description
Successful
Successful boolean

True if the operation was successful, false otherwise

TextItems
TextItems array of FineTextItem

Text items found in the input image

TextItemsCount
TextItemsCount integer

Count of text items found in the input image

FineTextItem

Individual instance of text occuring in an image; one piece of text

Name Path Type Description
Angle
Angle double

Rotation Angle in radians of the text

BottomLeftX
BottomLeftX integer

X coordinate of the bottom/left text location; 0 represents the left edge of the input image

BottomLeftY
BottomLeftY integer

Y coordinate of the bottom/left text location; 0 represents the top edge of the input image

BottomRightX
BottomRightX integer

X coordinate of the bottom/right text location; 0 represents the left edge of the input image

BottomRightY
BottomRightY integer

Y coordinate of the bottom/right text location; 0 represents the top edge of the input image

Height
Height integer

Height in pixels of the text

TopLeftX
TopLeftX integer

X coordinate of the top/left text location; 0 represents the left edge of the input image

TopLeftY
TopLeftY integer

Y coordinate of the top/left text location; 0 represents the top edge of the input image

TopRightX
TopRightX integer

X coordinate of the top/right text location; 0 represents the left edge of the input image

TopRightY
TopRightY integer

Y coordinate of the top/right text location; 0 represents the top edge of the input image

Width
Width integer

Width in pixels of the text

GenderDetectionResult

Result from classifying the Gender of people in an image

Name Path Type Description
PeopleIdentified
PeopleIdentified integer

Number of people identified in the image with a gender

PersonWithGender
PersonWithGender array of PersonWithGender

People in the image annotated with gender information

Successful
Successful boolean

True if the operation was successful, false otherwise

ImageDescriptionResponse

Result of recognizing an image

Name Path Type Description
BestOutcome
BestOutcome RecognitionOutcome

Specific recognition outcome

Highconfidence
Highconfidence boolean

Is the resulting best outcome recognition a high confidence outcome?

RunnerUpOutcome
RunnerUpOutcome RecognitionOutcome

Specific recognition outcome

Successful
Successful boolean

Was the image processed successfully?

ImageMetadata

Metadata from an image

Name Path Type Description
BitDepth
BitDepth integer

Bits per pixel

ColorSpace
ColorSpace string

Color space of the image

ExifProfileName
ExifProfileName string

Name of the EXIF profile used

ExifValues
ExifValues array of ImageMetadataExifValue

EXIF tags and values embedded in the image

FileFormat
FileFormat string

File format of the image

Height
Height integer

Height of the image in pixels

Successful
Successful boolean

True if the operation was successful, false otherwise

Width
Width integer

Width of the image in pixels

ImageMetadataExifValue

EXIF tag and value

Name Path Type Description
DataType
DataType string

Date type of the EXIF value

DataValue
DataValue string

Value, formatted as a string of the EXIF value

Tag
Tag string

Tag name for the EXIF value

NsfwResult

Result of an NSFW classification

Name Path Type Description
ClassificationOutcome
ClassificationOutcome string

Classification result into four categories: SafeContent_HighProbability, UnsafeContent_HighProbability, RacyContent, SafeContent_ModerateProbability

Score
Score double

Score between 0.0 and 1.0. Scores of 0.0-0.2 represent high probability safe content, while scores 0.8-1.0 represent high probability unsafe content. Content between 0.2 and 0.8 is of increasing raciness.

Successful
Successful boolean

True if the classification was successfully run, false otherwise

ObjectDetectionResult

Result of detecting objects in an image

Name Path Type Description
ObjectCount
ObjectCount integer

Number of objects detected in the scene

Objects
Objects array of DetectedObject

Array of objects detected in the scene

Successful
Successful boolean

Was the image processed successfully?

PersonWithAge

A person identified in an image age classification operation

Name Path Type Description
Age
Age double
AgeClass
AgeClass string

The person's age range classification result in years; possible values are "0-2", "4-6", "8-13", "15-20", "25-32", "38-43", "48-53", "60+"

AgeClassificationConfidence
AgeClassificationConfidence double

Confidence level of age classification; possible values are between 0.0 and 1.0; higher is better, with values > 0.50 being high confidence results

FaceLocation
FaceLocation Face

Location of one face in an image

PersonWithGender

A person identified in an image gender classification operation

Name Path Type Description
FaceLocation
FaceLocation Face

Location of one face in an image

GenderClass
GenderClass string

The person's identified gender; possible values are "Male", "Female" and "Unknown"

GenderClassificationConfidence
GenderClassificationConfidence double

Confidence level of gender classification; possible values are between 0.0 and 1.0; higher is better, with values > 0.50 being high confidence results

RecognitionOutcome

Specific recognition outcome

Name Path Type Description
ConfidenceScore
ConfidenceScore double

Scores closer to 1 are better than scores closer to 0

Description
Description string

English language description of the image

TextDetectionResult

Result of an operation to detect text in a photo

Name Path Type Description
Successful
Successful boolean

True if the operation was successful, false otherwise

TextItems
TextItems array of TextItem

Text items found in the input image

TextItemsCount
TextItemsCount integer

Count of text items found in the input image

TextItem

Individual instance of text occuring in an image; one piece of text

Name Path Type Description
Height
Height integer

Height in pixels of the text item

LeftX
LeftX integer

Left X coordinate of the text location; 0 represents the left edge of the input image

TopY
TopY integer

Top Y coordinate of the text location; 0 represents the top edge of the input image

Width
Width integer

Width in pixels of the text item

VehicleLicensePlateDetectionResult

Result of detecting vehicle license plates in an image

Name Path Type Description
DetectedLicensePlateCount
DetectedLicensePlateCount integer

The number of license plates detected in the image

DetectedLicensePlates
DetectedLicensePlates array of DetectedLicensePlate

License plates found in the image

Successful
Successful boolean

Was the image processed successfully?

binary

This is the basic data type 'binary'.