Microsoft Azure

Azure AI Services: Content Moderator

You use the API to scan your content as it's generated. Content Moderator then processes your content and sends the results, along with relevant information,…

AI & machine learning#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

You use the API to scan your content as it's generated. Content Moderator then processes your content and sends the results, along with relevant information, either back to your systems or to the built-in review tool. You can use this information to make decisions, like taking it down or sending it to a human judge.

When you're using the API, images need to have a minimum of 128 pixels and a maximum file size of 4 MB.
Text can be at most 1,024 characters long.
If the content passed to the text API or the image API exceeds the size limits, the API will return an error code that informs you about the issue.

Endpoints 35

ImageModeration

  • POSTImageModeration_FindFaces/contentmoderator/moderate/v1.0/ProcessImage/FindFaces?CacheImage=trueReturns the list of faces found.
  • POSTImageModeration_OCR/contentmoderator/moderate/v1.0/ProcessImage/OCR?language=string&CacheImage=true&enhanced=falseReturns any text found in the image for the specified language. If no language is specified in the input, the detection defaults to English.
  • POSTImageModeration_Evaluate/contentmoderator/moderate/v1.0/ProcessImage/Evaluate?CacheImage=trueReturns probabilities of the image containing racy or adult content.
  • POSTImageModeration_Match/contentmoderator/moderate/v1.0/ProcessImage/Match?listId=string&CacheImage=trueFuzzily match an image against one of your custom image lists. You can create and manage your custom image lists by using <a…

TextModeration

  • POSTDetect profanity and match against custom and shared blocklists/contentmoderator/moderate/v1.0/ProcessText/Screen/?language=string&autocorrect=false&PII=false&listId=string&classify=falseDetects profanity in more than 100 languages and matches against custom and shared blocklists.
  • POSTTextModeration_DetectLanguage/contentmoderator/moderate/v1.0/ProcessText/DetectLanguageThis operation detects the language of input content. It returns the <a href="http://www-01.sil.org/iso639-3/codes.asp">ISO 639-3 code</a> for the predominant…

ListManagementImageLists

  • GETListManagementImageLists_GetDetails/contentmoderator/lists/v1.0/imagelists/:listIdReturns the details of the image list with listId equal to the passed list ID.
  • PUTListManagementImageLists_Update/contentmoderator/lists/v1.0/imagelists/:listIdUpdates an image list with listId equal to the passed list ID.
  • DELETEListManagementImageLists_Delete/contentmoderator/lists/v1.0/imagelists/:listIdDeletes the image list with listId equal to the passed list ID.
  • GETListManagementImageLists_GetAllImageLists/contentmoderator/lists/v1.0/imagelistsGets all the image lists.
  • POSTListManagementImageLists_Create/contentmoderator/lists/v1.0/imagelistsCreates an image list.
  • POSTListManagementImageLists_RefreshIndex/contentmoderator/lists/v1.0/imagelists/:listId/RefreshIndexRefreshes the index of the list with listId equal to the passed list ID.

ListManagementTermLists

  • GETListManagementTermLists_GetDetails/contentmoderator/lists/v1.0/termlists/:listIdReturns list ID details of the term list with listId equal to the passed list ID.
  • PUTListManagementTermLists_Update/contentmoderator/lists/v1.0/termlists/:listIdUpdates a term list.
  • DELETEListManagementTermLists_Delete/contentmoderator/lists/v1.0/termlists/:listIdDeletes the term list with listId equal to the passed list ID.
  • GETListManagementTermLists_GetAllTermLists/contentmoderator/lists/v1.0/termlistsGets all the term lists.
  • POSTListManagementTermLists_Create/contentmoderator/lists/v1.0/termlistsCreates a term list.
  • POSTListManagementTermLists_RefreshIndex/contentmoderator/lists/v1.0/termlists/:listId/RefreshIndex?language=stringRefreshes the index of the list with listId equal to the passed list ID.

ListManagementImage

  • GETListManagementImage_GetAllImageIds/contentmoderator/lists/v1.0/imagelists/:listId/imagesGets all image IDs from the list with listId equal to the passed list ID.
  • POSTListManagementImage_AddImage/contentmoderator/lists/v1.0/imagelists/:listId/images?tag=0&label=stringAdd an image to the list with listId equal to the passed list ID.
  • DELETEListManagementImage_DeleteAllImages/contentmoderator/lists/v1.0/imagelists/:listId/imagesDeletes all images from the list with listId equal to the passed list ID.
  • DELETEListManagementImage_DeleteImage/contentmoderator/lists/v1.0/imagelists/:listId/images/:ImageIdDeletes an image from the list with the passed list ID and image ID.

ListManagementTerm

  • POSTListManagementTerm_AddTerm/contentmoderator/lists/v1.0/termlists/:listId/terms/:term?language=stringAdds a term to the term list with listId equal to the passed list ID.
  • DELETEListManagementTerm_DeleteTerm/contentmoderator/lists/v1.0/termlists/:listId/terms/:term?language=stringDeletes a term from the list with listId equal to the passed list ID.
  • GETListManagementTerm_GetAllTerms/contentmoderator/lists/v1.0/termlists/:listId/terms?language=string&offset=0&limit=0Gets all terms from the list with listId equal to the passed list ID.
  • DELETEListManagementTerm_DeleteAllTerms/contentmoderator/lists/v1.0/termlists/:listId/terms?language=stringDeletes all terms from the list with listId equal to the passed list ID.

Reviews

  • GETReviews_GetReview/contentmoderator/review/v1.0/teams/:teamName/reviews/:reviewIdReturns review details for the passed review ID.
  • GETReviews_GetJobDetails/contentmoderator/review/v1.0/teams/:teamName/jobs/:JobIdGet the job details for a job ID.
  • POSTReviews_CreateReviews/contentmoderator/review/v1.0/teams/:teamName/reviews?subTeam=stringThe created reviews appear for reviewers on your team. As reviewers finish reviewing, results of the reviews are posted (that is, HTTP POST) on the specified…
  • POSTReviews_CreateJob/contentmoderator/review/v1.0/teams/:teamName/jobs?ContentType=Image&ContentId=string&WorkflowName=string&CallBackEndpoint=stringA job ID will be returned for the content posted on this endpoint. After the content is evaluated against the provided workflow, the review will be created or…
  • GETReviews_GetVideoFrames/contentmoderator/review/v1.0/teams/:teamName/reviews/:reviewId/frames?startSeed=0&noOfRecords=0&filter=stringThe created reviews appear for reviewers on your team. As reviewers finish reviewing, results of the reviews are posted (that is, HTTP POST) on the specified…
  • POSTReviews_AddVideoFrame/contentmoderator/review/v1.0/teams/:teamName/reviews/:reviewId/frames?timescale=0The created reviews appear for reviewers on your team. As reviewers finish reviewing, results of the reviews are posted (that is, HTTP POST) on the specified…
  • POSTReviews_PublishVideoReview/contentmoderator/review/v1.0/teams/:teamName/reviews/:reviewId/publishPublish a video review.
  • PUTReviews_AddVideoTranscriptModerationResult/contentmoderator/review/v1.0/teams/:teamName/reviews/:reviewId/transcriptmoderationresultThis API adds a transcript screen text result file for a video review. The transcript screen text result file is a result of the Screen Text API. To generate…
  • PUTReviews_AddVideoTranscript/contentmoderator/review/v1.0/teams/:teamName/reviews/:reviewId/transcriptThis API adds a transcript file (text version of all the words spoken in a video) to a video review. The file should be in a valid WebVTT format.

API details

Authentication
An API key in the Ocp-Apim-Subscription-Key header
Operations
35 operations on 24 pathsPOST 16GET 9DELETE 6PUT 4
Main resources
Reviews 9ListManagementImageLists 6ListManagementTermLists 6ImageModeration 4ListManagementImage 4ListManagementTerm 4TextModeration 2
Description format
Swagger 2.0, API version 1.0

How to test the Azure AI Services: Content Moderator in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure AI Services: Content Moderator collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Ocp-Apim-Subscription-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “ImageModeration_FindFaces” (POST /contentmoderator/moderate/v1.0/ProcessImage/FindFaces?CacheImage=true), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure AI Services: Content Moderator?

You use the API to scan your content as it's generated. Content Moderator then processes your content and sends the results, along with relevant information,… It is listed under AI & machine learning and has 35 endpoints.

Who publishes the Azure AI Services: Content Moderator?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure AI Services: Content Moderator?

With an API key in the Ocp-Apim-Subscription-Key header.

How many endpoints does the Azure AI Services: Content Moderator have?

35 operations on 24 paths (16 POST, 9 GET, 6 DELETE, 4 PUT). The largest groups are Reviews, ListManagementImageLists, ListManagementTermLists, ImageModeration.

Is forking the Azure AI Services: Content Moderator free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.