Generate named entities

This endpoint allows you to extract named entities from an existing media. Named Entity Recognition (NER) is a fundamental natural language processing (NLP) technique that identifies and classifies key information (entities) in text into predefined categories. For instance:

  • Organizations (for example, "Microsoft", "United Nations")
  • Locations (for example, "Paris", "Mount Everest")
  • Product names (for example, "iPhone", "Coca-Cola")

How it works

  1. Make a PATCH request to this endpoint, replacing <mediaId> with the ID of the media you want to extract named-entities.
  2. Include the namedEntities parameter in the request body to enable.
  3. Receive a response containing the updated media data, confirming the changes made.

You can use the video.mediaAI.named-entities.ready webhook event to track and notify about the named entities extraction.

Use case: If a user uploads a video and later decides to enable named entity extraction without re-uploading the entire video.

Related guide: Named entities

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier assigned to the media when created. The value must be a valid UUID.

Body Params
boolean
required

Enable or disable named entity extraction. Set to true to enable or false to disable.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json