Skip to navigation
IN-VIDEO AI APINamed entities

Extract named entities from video

This endpoint extracts named entities mentioned in an existing media, such as people, organizations, brands, products, and locations. The extracted entities make it easier to classify, search, and enrich video content with relevant metadata.

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 request was successful and returns the ID of the media. The job starts immediately after a successful request.
  3. You can use the video.media.ai.named_entities.ready webhook event to track and notify the status.
  4. 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 to extract named entities from media that has already been uploaded, without requiring the user to upload it again.

Related guide: Named entities

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

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