Table of Contents

  1. Introduction
  2. Examples
  3. Credits

Introduction


Uses a pre-trained model to detect faces in a given image. Send your input as a url to a picture that is either hosted on our data API or is a direct link, and the output is the same image, with rectangles around the detected faces, written to your collection. A text file that contains all the coordinates of the rectangles is also output to the same collection for convenience. The text file contains 4 integers: the x and y coordinates of the top left of the rectangle, the width of the rectangle and the height of the rectangle.

Input:

  • (Required): Image URL or Data API URL.
  • (Required): Processed image file destination.

Output:

  • Processed image file destination.

Examples

Example 1.

  • Parameter 1: Carl Sagan image URL
  • Parameter 2: Processed image file destination
[
    "https://upload.wikimedia.org/wikipedia/commons/b/be/Carl_Sagan_Planetary_Society.JPG",
    "data://.algo/temp/result.jpg"
]

Output:

"data://.algo/temp/result.jpg"

Credits

This face detection algorithm is based on the openCV library.

Writing good docs:

Communicate Value

A good introduction should make it clear why someone might use your API.

Show and Tell

Give examples of using your API and explain those examples.

Easy to Skim

Ensure your docs are structured such that familiar users can quickly jump to the content they want.

Current

Revisit your docs after making breaking changes or adding new features to keep them up-to-date.