How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VideoGen Webhook events API

Event payloads delivered to your registered webhook endpoints.

VideoGen Webhook events API is one of 11 APIs that VideoGen publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Webhook Events. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 0 operations across 0 paths, and defines 30 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.videogen.io.

0 operations 0 paths 30 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.videogen.io
Authentication
HTTP Bearer

Authentication & Security 1

VideoGen Webhook events API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (opaque) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API key from [app.videogen.io/api](https://app.videogen.io/api). The full key is only shown once when you create it.

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are FileInfo (23 properties), WorkflowRunWebhookPayload (13 properties), AssistantOutputMessage (10 properties), ToolSuccessResult (7 properties). Each schema is shown below with its type and property counts.

AssistantMessageWebhookEventName
string
Lifecycle events for assistant messages started via the developer API.
ToolExecutionWebhookEventName
string
Webhook event types for tool execution lifecycle.
FileWebhookEventName
string
Webhook event types for the file lifecycle (upload, analysis, playback, and download readiness). Only fired for files uploaded via the API (not the VideoGen UI…
AssistantWorkflowSuggestion
object
A starting-point workflow the assistant suggests for the conversation. Act on it with POST /v1/assistants/{assistantId}/actions/{actionId} to select the workfl…
4 properties 4 required
AssistantOutputMessage
object
An assistant-authored message in an assistant chat, including any suggestions or actions it offered.
10 properties 10 required
FileInfo
object
Metadata for a generated file. Obtain ids from tool results or GET /v1/files.
23 properties 2 required
WorkflowRunWebhookEventName
string
Lifecycle events emitted for workflow runs started via the developer API.
FileSource
object
A rendition source for a file (e.g. thumbnail, preview, download). Contains a signed URL and metadata.
6 properties 1 required
AssistantMessageAttachment
object
A file linked to an assistant chat message.
2 properties 1 required
AssistantMessageStatus
string
Lifecycle status of an assistant chat message. pending and running are in-progress; succeeded, failed, and cancelled are terminal.
ApiError
object
Standard error body returned with every non-2xx response (the default response of every operation). The HTTP status code conveys the error class; this body car…
4 properties 1 required
StartWorkflowRunResponse
object
Returned when a workflow run is accepted. Poll GET /v1/workflows/runs/{workflowRunId} or subscribe to webhooks for completion. When the start request set autoE…
4 properties 4 required
ErrorRequirement
object
What is needed to resolve an error, when it can be fixed by fulfilling a specific requirement (e.g. purchasing an add-on or upgrading the plan).
2 properties 1 required
ProjectExportWebhookEventName
string
Lifecycle events emitted for project exports started via the developer API (POST /v1/projects/{projectId}/export).
FileWebhookPayload
object
Delivered to your webhook endpoint during the file lifecycle (upload, analysis, playback, and download readiness). Only sent for files uploaded via the API. Th…
5 properties 4 required
WorkflowRunWebhookPayload
object
Body POSTed to a registered webhook endpoint when a workflow run reaches a terminal state. When the run was started with autoExport: true, workflowrun.succeede…
13 properties 12 required
TranscriptWord
object
A single timed word of a transcript.
3 properties 3 required
AssistantAction
object
An actionable widget the assistant offered on this turn. Act on it with POST /v1/assistants/{assistantId}/actions/{actionId} unless requiresApp is true.
5 properties 4 required
Transcript
object
A transcript of an audio file, as timed words in order.
2 properties 1 required
WorkflowType
string
Workflow type identifier.
AssistantInputMessage
object
A user-authored message in an assistant chat.
6 properties 6 required
AssistantActionDetail
object
Extra data for rendering this action inline (in a chat surface or integration) without opening the web app. Fields are populated only when relevant to the acti…
3 properties
AssistantMessageWebhookPayload
object
Body POSTed to a registered webhook endpoint when an assistant message reaches a terminal state. Mirrors the AssistantMessage GET response.
4 properties 4 required
ToolExecutionWebhookPayload
object
Delivered to your webhook endpoint when a tool execution reaches a terminal state. The shape mirrors the ExecutedTool response with the addition of event and o…
6 properties 4 required
AssistantMessage
A single message in an assistant chat. Discriminated by role.
ToolSuccessResult
object
Result for a single generated file. Only appears inside a succeeded execution's results, so every field below is always present.
7 properties 7 required
ProjectExportWebhookPayload
object
Body POSTed to a registered webhook endpoint when a project export started via the API reaches a terminal state. Use exportId with GET /v1/projects/{projectId}…
6 properties 5 required
FileAnalysisMetadata
object
Background analysis state for a file. Background analysis populates description, transcript, durationSeconds, and the search embedding after a file is uploaded…
3 properties 2 required
AssistantActionKind
string
Normalized category of an actionable widget the assistant offered. APPROVEPLAN accepts a proposed generation plan; APPLYEDIT applies a proposed edit (e.g. a re…
FileType
string
File type. TEXT covers plain-text and editor-interchange documents; LOTTIE is a JSON animation.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

videogen-io-webhook-events-api-openapi.yml Raw ↑

Other APIs VideoGen publishes across the network.

VideoGen Account API
VideoGen Assistant API
VideoGen Entities API
VideoGen Files API
VideoGen Projects API
VideoGen Resources API
VideoGen Text API
VideoGen Tools API
VideoGen Webhooks API
VideoGen Workflows API
Where this information came from

This is an independent, third-party profile of VideoGen Webhook events API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.