In-video AI events
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.
| Field | Type | Description |
|---|---|---|
| type | string | Type for the webhook event. |
| id | string | Unique identifier for the event. |
| workspace | object | Workspace information. |
| workspace.name | string | Name of the workspace. |
| workspace.id | string | Unique ID for the workspace (e.g., "a56a1e42-65ec-4f9d-9fc1-89d24cd59348"). |
| status | string | Status of the media. Possible values: "ready". |
| data | object | Data related to the media event. |
| -data.isChaptersGenerated | boolean | Indicates if chapters were generated (true / false). |
| -data.chapters | array | List of chapters for the media. |
| -data.chapters[].chapter | string | Chapter number (e.g., "1"). |
| -data.chapters[].startTime | string | Start time of the chapter (e.g., "00:00:00"). |
| -data.chapters[].endTime | string | End time of the chapter (e.g., "00:00:52"). |
| -data.chapters[].title | string | Title of the chapter. |
| -data.chapters[].summary | string | Summary of the chapter. |
| createdAt | string | Timestamp when the event was created (e.g., "2025-01-17T05:52:14.088348957Z"). |
| attempts | array | List 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.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event. |
| id | string | Unique identifier for the event. |
| workspace | object | Workspace information. |
| workspace.name | string | Name of the workspace. |
| workspace.id | string | Unique identifier for the workspace (e.g., "a56a1e42-65ec-4f9d-9fc1-89d24cd59348"). |
| status | string | Status of the media. Possible values: "ready". |
| -data | object | Data related to the media event. |
| -data.isNamedEntitiesGenerated | boolean | Indicates if named entities were generated (true / false). |
| -data.namedEntities | object | Information about the named entities. |
| -data.namedEntities.entityCount | integer | Count of the named entities generated (e.g., 2). |
| -data.namedEntities.namedEntities | array | List of named entities identified in the media. |
| -data.namedEntities.namedEntities[].entity | string | The named entity. |
| -data.namedEntities.namedEntities[].category | string | Category of the named entity. |
| createdAt | string | Timestamp when the event was created (e.g., "2025-01-17T05:52:19.601920651Z"). |
| attempts | array | List 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.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event. |
| id | string | Unique identifier for the event. |
| workspace | object | Workspace information. |
| workspace.name | string | Name of the workspace. |
| workspace.id | string | Unique identifier for the workspace (e.g., "a56a1e42-65ec-4f9d-9fc1-89d24cd59348"). |
| status | string | Status of the media. Possible values: "ready". |
| data | object | Data related to the media event. |
| -data.isSummaryGenerated | boolean | Indicates if a summary was generated (true / false). |
| -data.summary | string | The summary of the media content. |
| createdAt | string | Timestamp when the event was created (e.g., "2025-01-17T05:52:27.333581529Z"). |
| attempts | array | List 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.
| Name | Type | Description |
|---|---|---|
| type | string | Type for the webhook event. |
| id | string | Unique identifier for the event. |
| workspace | object | Workspace information. |
| workspace.name | string | Name of the workspace. |
| workspace.id | string | Unique identifier for the workspace (e.g., "a56a1e42-65ec-4f9d-9fc1-89d24cd59348"). |
| status | string | Status of the media. Possible values: "ready". |
| data | object | Data related to the media event. |
| -data.isModerationGenerated | boolean | Indicates if moderation results were generated (true / false). |
| -data.moderationResult | object | The moderation results of the media content. |
| -data.moderationResult.categoryScores | array | List of category scores for moderation. |
| -data.moderationResult.categoryScores[].category | string | The moderation category. |
| -data.moderationResult.categoryScores[].score | number | The score for the given category. |
| createdAt | string | Timestamp when the event was created (e.g., "2025-01-17T05:52:32.319576585Z"). |
| attempts | array | List of attempts, if any. |
Updated 10 days ago