Generate named entities | FastPix Developer Documentation

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

How it works

Make a PATCH request to this endpoint, replacing <mediaId> with the ID of the media you want to extract named-entities.
Include the namedEntities parameter in the request body to enable.
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

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 <a href="https://docs.fastpix.io/docs/ai-events#videomediaainamedentitiesready">video.mediaAI.named-entities.ready</a> 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: <a href="https://docs.fastpix.io/docs/generate-named-entities">Named entities</a>

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

Username: Access Token ID
Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request. - <b>Username:</b> Access Token ID - <b>Password:</b> Secret Key Activate your FastPix account to generate your API credentials. <a href="https://docs.fastpix.io/docs/activate-account" target="_blank">See the guide here</a>

Path parameters

mediaIdstringRequiredformat: "uuid"

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

Request

This endpoint expects an object.

namedEntitiesbooleanRequired

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

Response

Media details updated successfully with the named entity extraction feature enabled or disabled

successboolean

Indicates if the request was successful or not.

dataobject

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

How it works

Make a PATCH request to this endpoint, replacing <mediaId> with the ID of the media you want to extract named-entities.
Include the namedEntities parameter in the request body to enable.
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

$	curl -X PATCH https://api.fastpix.com/v1/on-demand/0cec3c88-c69d-4232-9b96-f0976327fa2d/named-entities \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"namedEntities": true
>	}'

1	{
2	"success": true,
3	"data": {
4	"mediaId": "c695988b-ff84-42ae-bb21-10f284fedb0e",
5	"isNamedEntitiesEnabled": true
6	}
7	}