Extract named entities from video | FastPix Developer Documentation

This endpoint generates named entities for an existing media.

How it works

Send a POST request to this endpoint, replacing <mediaId> with the ID of the media for which you want to extract named entities.
The response confirms that the update was successful and returns the ID of the media. The job starts immediately upon successfull request.
You can use the video.media.ai.named_entities.ready webhook event to track and notify the status.
After the webhook event is received, you can use the Get named entities endpoint to retrieve the extracted named entities.

Use case: Use this feature when a user uploads a video or any media and wants to extract named entities.

This endpoint generates named entities for an existing media. #### How it works 1. Send a `POST` request to this endpoint, replacing `<mediaId>` with the ID of the media for which you want to extract named entities. 2. The response confirms that the update was successful and returns the ID of the media. The job starts immediately upon successfull request. 3. You can use the [video.media.ai.named_entities.ready](https://fastpix.com/docs/webhooks/in-video-ai-events#videomediaainamed_entitiesready) webhook event to track and notify the status. 4. After the webhook event is received, you can use the [Get named entities](#get-named-entities) endpoint to retrieve the extracted named entities. **Use case**: Use this feature when a user uploads a video or any media and wants to extract named entities. Related guide: <a href="https://fastpix.com/docs/in-video-ai/extract-named-entities-from-a-video">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://fastpix.com/docs/getting-started/activate-your-account" target="_blank">See the guide here</a>

Path parameters

mediaIdstringRequiredformat: "uuid"

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

Response

Successfully triggered named entities extraction.

successbooleanOptional

Shows the request status. Returns true for success and false for failure.

dataobjectOptional

This endpoint generates named entities for an existing media.

How it works

Send a POST request to this endpoint, replacing <mediaId> with the ID of the media for which you want to extract named entities.
The response confirms that the update was successful and returns the ID of the media. The job starts immediately upon successfull request.
You can use the video.media.ai.named_entities.ready webhook event to track and notify the status.
After the webhook event is received, you can use the Get named entities endpoint to retrieve the extracted named entities.

Use case: Use this feature when a user uploads a video or any media and wants to extract named entities.

Related guide: Named entities