For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusSupportDiscussionsLog inSign Up
Docs HomeAPI ReferenceVideo on DemandAI FeaturesLive StreamingVideo PlayerVideo DataCloud PlayoutRecipes
Docs HomeAPI ReferenceVideo on DemandAI FeaturesLive StreamingVideo PlayerVideo DataCloud PlayoutRecipes
  • Get started
    • Overview
  • Video intelligence
    • Detect NSFW content and profanity
    • Extract named entities from a video
    • Generate video chapters
    • Generate a video summary
  • AI Agents
    • Notes Agent
  • AI events
    • In-video AI events
LogoLogo
StatusSupportDiscussionsLog inSign Up
On this page
  • video.mediaAI.chapters.ready
  • video.mediaAI.namedEntities.ready
  • video.mediaAI.summary.ready
  • video.mediaAI.moderation.ready
AI events

In-video AI events

Explore in-video AI events in FastPix, including chapters, Named Entities Recognition, summaries, and moderation features.

Was this page helpful?
Previous
Built with

FastPix’s in-video AI events provide insights into the analysis and processing of media content. These events include:

video.mediaAI.chapters.ready

This event is triggered when chapters are generated for a media file. It provides information about the chapters within the media, including their start and end times, titles, and summaries. The event also indicates if chapters were successfully generated. This can be used to track when chapters are created and monitor the structure of the content for easier navigation.


FieldTypeDescription
typestringType for the webhook event.
idstringUnique identifier for the event.
workspaceobjectWorkspace information.
workspace.namestringName of the workspace.
workspace.idstringUnique ID for the workspace (e.g., “a56a1e42-65ec-4f9d-9fc1-89d24cd59348”).
statusstringStatus of the media. Possible values: "ready".
dataobjectData related to the media event.
-data.isChaptersGeneratedbooleanIndicates if chapters were generated (true / false).
-data.chaptersarrayList of chapters for the media.
-data.chapters[].chapterstringChapter number (e.g., “1”).
-data.chapters[].startTimestringStart time of the chapter (e.g., “00:00:00”).
-data.chapters[].endTimestringEnd time of the chapter (e.g., “00:00:52”).
-data.chapters[].titlestringTitle of the chapter.
-data.chapters[].summarystringSummary of the chapter.
createdAtstringTimestamp when the event was created (e.g., “2025-01-17T05:52:14.088348957Z”).
attemptsarrayList of attempts, if any.

video.mediaAI.namedEntities.ready

This event is triggered when named entities are identified within a media file. It provides details about the named entities, including their count, the entity name, and their associated category. This event can be used to track the recognition of specific entities, such as people, organizations, or locations, within the content, allowing for enhanced analysis and insights.


NameTypeDescription
typestringType for the webhook event.
idstringUnique identifier for the event.
workspaceobjectWorkspace information.
workspace.namestringName of the workspace.
workspace.idstringUnique identifier for the workspace (e.g., “a56a1e42-65ec-4f9d-9fc1-89d24cd59348”).
statusstringStatus of the media. Possible values: "ready".
-dataobjectData related to the media event.
-data.isNamedEntitiesGeneratedbooleanIndicates if named entities were generated (true / false).
-data.namedEntitiesobjectInformation about the named entities.
-data.namedEntities.entityCountintegerCount of the named entities generated (e.g., 2).
-data.namedEntities.namedEntitiesarrayList of named entities identified in the media.
-data.namedEntities.namedEntities[].entitystringThe named entity.
-data.namedEntities.namedEntities[].categorystringCategory of the named entity.
createdAtstringTimestamp when the event was created (e.g., “2025-01-17T05:52:19.601920651Z”).
attemptsarrayList of attempts, if any.

video.mediaAI.summary.ready

This event is triggered when a summary is generated for a media file. It provides the summary of the content, offering a brief overview or key points of the media. This event can be used to track when summaries are created, helping users or systems quickly understand the essence of the media without needing to watch or listen to the entire content.


NameTypeDescription
typestringType for the webhook event.
idstringUnique identifier for the event.
workspaceobjectWorkspace information.
workspace.namestringName of the workspace.
workspace.idstringUnique identifier for the workspace (e.g., “a56a1e42-65ec-4f9d-9fc1-89d24cd59348”).
statusstringStatus of the media. Possible values: "ready".
dataobjectData related to the media event.
-data.isSummaryGeneratedbooleanIndicates if a summary was generated (true / false).
-data.summarystringThe summary of the media content.
createdAtstringTimestamp when the event was created (e.g., “2025-01-17T05:52:27.333581529Z”).
attemptsarrayList of attempts, if any.

video.mediaAI.moderation.ready

This event is triggered when moderation results are generated for a media file. It provides information about the moderation analysis, including category scores that evaluate different aspects of the content, such as violence, adult content, or offensive language. This event can be used to track when moderation results are available, helping ensure content meets the required guidelines and standards.


NameTypeDescription
typestringType for the webhook event.
idstringUnique identifier for the event.
workspaceobjectWorkspace information.
workspace.namestringName of the workspace.
workspace.idstringUnique identifier for the workspace (e.g., “a56a1e42-65ec-4f9d-9fc1-89d24cd59348”).
statusstringStatus of the media. Possible values: "ready".
dataobjectData related to the media event.
-data.isModerationGeneratedbooleanIndicates if moderation results were generated (true / false).
-data.moderationResultobjectThe moderation results of the media content.
-data.moderationResult.categoryScoresarrayList of category scores for moderation.
-data.moderationResult.categoryScores[].categorystringThe moderation category.
-data.moderationResult.categoryScores[].scorenumberThe score for the given category.
createdAtstringTimestamp when the event was created (e.g., “2025-01-17T05:52:32.319576585Z”).
attemptsarrayList of attempts, if any.