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 Assistant API

Converse with the VideoGen AI assistant inside a project. Start a chat, send messages, and act on the assistant's suggestions (pick a workflow, approve a plan, generate). All calls are asynchronous: POSTing a message returns a `messageId` (e.g. `vg_mesg_...`); poll `GET /v1/assistant-messages/{messageId}` until `status` is `succeeded`, `failed`, or `cancelled`, or subscribe to `assistant_message.*` webhooks.

VideoGen Assistant 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 Assistant. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 5 operations across 5 paths, and defines 20 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.

5 operations 5 paths 20 schemas 2 GET3 POST

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
Resource Areas
1

Authentication & Security 1

VideoGen Assistant 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.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Assistant 5

Converse with the VideoGen AI assistant inside a project. Start a chat, send messages, and act on the assistant's suggestions (pick a workflow, approve a plan, generate). All call…

POST
/v1/assistants
Start an assistant chat
startAssistantChat body → 202default
GET
/v1/assistants/{assistantId}
Get an assistant chat
getAssistant 1 param → 200default
POST
/v1/assistants/{assistantId}/messages
Send an assistant message
sendAssistantMessage 1 param body → 202default
POST
/v1/assistants/{assistantId}/actions/{actionId}
Act on an assistant action
actOnAssistantAction 2 params body → 202default
GET
/v1/assistant-messages/{messageId}
Get an assistant message
getAssistantMessage 1 param → 200default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are AssistantOutputMessage (10 properties), AssistantInputMessage (6 properties), AssistantAction (5 properties), ApiError (4 properties). Each schema is shown below with its type and property counts.

ActOnAssistantActionResponse
object
Returned when a POST /v1/assistants/{assistantId}/actions/{actionId} call is accepted. Use messageId to poll the resulting assistant message.
1 property 1 required
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
SendAssistantMessageResponse
object
Returned when a POST /v1/assistants/{assistantId}/messages call is accepted. Use messageId to poll the pending assistant reply.
1 property 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
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
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
GetAssistantResponse
object
An assistant chat and every message it currently contains.
4 properties 4 required
AssistantMessage
A single message in an assistant chat. Discriminated by role.
ActOnAssistantActionRequest
object
1 property
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…
SendAssistantMessageRequest
object
1 property 1 required
StartAssistantChatResponse
object
Returned when a POST /v1/assistants call is accepted. Poll messageId for the pending assistant reply; keep assistantId / projectId to continue the chat and add…
4 properties 4 required
StartAssistantChatRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

videogen-io-assistant-api-openapi.yml Raw ↑

Other APIs VideoGen publishes across the network.

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

This is an independent, third-party profile of VideoGen Assistant 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.