generated: '2026-10-02'
method: derived
generator: derive-vocabulary.py
source: openapi/videogen-io-openapi.json
vocabulary:
  name: VideoGen Domain Vocabulary
  description: 'Terms declared by VideoGen''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-02'
  terms:
  - term: Workflows
    definition: End-to-end async video workflows. Each endpoint starts a workflow run that creates a project and generates a video.
    tags:
    - Resource Group
    source: openapi/videogen-io-openapi.json
  - term: Projects
    definition: Read project metadata and status.
    tags:
    - Resource Group
    source: openapi/videogen-io-openapi.json
  - term: Assistant
    definition: '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.*'
    tags:
    - Resource Group
    source: openapi/videogen-io-openapi.json
  - term: Tools
    definition: Generate images, videos, audio, and more. All tool endpoints are asynchronous.
    tags:
    - Resource Group
    source: openapi/videogen-io-openapi.json
  - term: Text
    definition: Generate text with a general-purpose language model. Synchronous — the response includes the generated text.
    tags:
    - Resource Group
    source: openapi/videogen-io-openapi.json
  - term: Files
    definition: List and retrieve metadata for generated files.
    tags:
    - Resource Group
    source: openapi/videogen-io-openapi.json
  - term: Entities
    definition: Reusable actors and visual styles. Attach their reference images to workflows for consistent characters and looks across generations.
    tags:
    - Resource Group
    source: openapi/videogen-io-openapi.json
  - term: Resources
    definition: Discover available TTS voices and supported languages to use in requests.
    tags:
    - Resource Group
    source: openapi/videogen-io-openapi.json
  - term: Webhooks
    definition: Register endpoints to receive `tool_execution.*` and `workflow_run.*` events instead of polling.
    tags:
    - Resource Group
    source: openapi/videogen-io-openapi.json
  - term: Account
    definition: Look up the account and team behind the API key. Useful as a connection test to confirm a key is valid.
    tags:
    - Resource Group
    source: openapi/videogen-io-openapi.json
  - term: Webhook events
    definition: Event payloads delivered to your registered webhook endpoints.
    tags:
    - Resource Group
    source: openapi/videogen-io-openapi.json
  - term: FileType
    definition: File type. `TEXT` covers plain-text and editor-interchange documents; `LOTTIE` is a JSON animation.
    tags:
    - Enumeration
    source: openapi/videogen-io-openapi.json#/components/schemas/FileType
  - term: FileInfo
    definition: Metadata for a generated file. Obtain ids from tool results or `GET /v1/files`.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/FileInfo
  - term: FileSource
    definition: A rendition source for a file (e.g. thumbnail, preview, download). Contains a signed URL and metadata.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/FileSource
  - term: FileAnalysisMetadata
    definition: Background analysis state for a file. Background analysis populates `description`, `transcript`, `durationSeconds`, and the search
      embedding after a file is uploaded or generated; this object lets you render a progress indicator while it runs (and skip rendering once
      it's done).
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/FileAnalysisMetadata
  - term: SearchFilesRequest
    definition: 'Object declared by the contract with fields: query, numResults, selfOnly.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/SearchFilesRequest
  - term: SearchFilesResponse
    definition: 'Object declared by the contract with fields: results.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/SearchFilesResponse
  - term: SearchFilesResult
    definition: 'Object declared by the contract with fields: similarity, file.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/SearchFilesResult
  - term: CreateFileUploadRequest
    definition: 'Object declared by the contract with fields: type, displayName, isTemporary, hideFromUi, transcript.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/CreateFileUploadRequest
  - term: FileUploadResponse
    definition: 'Object declared by the contract with fields: fileId, uploadUrl.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/FileUploadResponse
  - term: GetFilesResponse
    definition: 'Object declared by the contract with fields: files, hasMore, nextCursor.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/GetFilesResponse
  - term: EntityReference
    definition: A file attached to an entity as a reference image.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/EntityReference
  - term: EntityActorConfig
    definition: Read-only voice and avatar summary for an ACTOR entity. Always null for non-ACTOR entities.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/EntityActorConfig
  - term: Entity
    definition: A reusable actor, product, visual style, or slideshow theme. Attach its reference images to workflows for consistent characters,
      looks, and slide designs.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/Entity
  - term: ListEntitiesResponse
    definition: 'Object declared by the contract with fields: entities, hasMore, nextCursor.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/ListEntitiesResponse
  - term: CreateEntityRequest
    definition: 'Object declared by the contract with fields: entityType, name, description.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/CreateEntityRequest
  - term: UpdateEntityRequest
    definition: At least one field must be provided.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/UpdateEntityRequest
  - term: EntityArchiveResponse
    definition: 'Object declared by the contract with fields: entityId, archived.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/EntityArchiveResponse
  - term: AddEntityReferenceRequest
    definition: 'Object declared by the contract with fields: fileId, description, isDefault.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/AddEntityReferenceRequest
  - term: RemoveEntityReferenceRequest
    definition: 'Object declared by the contract with fields: fileId.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/RemoveEntityReferenceRequest
  - term: TtsVoice
    definition: A text-to-speech voice.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/TtsVoice
  - term: MeResponse
    definition: 'Object declared by the contract with fields: apiKeyId, apiKeyNickname, email, displayName, teamId.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/MeResponse
  - term: TtsVoiceListResponse
    definition: 'Object declared by the contract with fields: ttsVoices, hasMore, nextCursor.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/TtsVoiceListResponse
  - term: Language
    definition: A language a project can be translated into.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/Language
  - term: LanguageListResponse
    definition: 'Object declared by the contract with fields: languages.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/LanguageListResponse
  - term: WatermarkMode
    definition: Controls whether the VideoGen watermark is applied to the output. `AUTO` applies the watermark unless you have a Pro plan. `VIDEO_GEN`
      always applies it. `NONE` removes the watermark (requires Pro; returns an error if you don't have it).
    tags:
    - Enumeration
    source: openapi/videogen-io-openapi.json#/components/schemas/WatermarkMode
  - term: EndScreenMode
    definition: Controls whether a short 'Made with VideoGen' end screen is appended to the output. `AUTO` appends it unless you have a Pro plan.
      `VIDEO_GEN` always appends it. `NONE` removes it (requires Pro; returns an error if you don't have it).
    tags:
    - Enumeration
    source: openapi/videogen-io-openapi.json#/components/schemas/EndScreenMode
  - term: ContentPolicyConfig
    definition: Controls how content-policy rejections are handled during generation.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/ContentPolicyConfig
  - term: AspectRatio
    definition: Aspect ratio as a width:height pair (e.g. 16 and 9 for 16:9). Not pixel dimensions.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/AspectRatio
  - term: GenerateTextRequest
    definition: 'Object declared by the contract with fields: prompt, system, quality, temperature, maxOutputTokens.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/GenerateTextRequest
  - term: GenerateTextResponse
    definition: 'Object declared by the contract with fields: text.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/GenerateTextResponse
  - term: StartAssistantChatRequest
    definition: 'Object declared by the contract with fields: message, autoGenerate.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/StartAssistantChatRequest
  - term: SendAssistantMessageRequest
    definition: 'Object declared by the contract with fields: message.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/SendAssistantMessageRequest
  - term: ActOnAssistantActionRequest
    definition: 'Object declared by the contract with fields: decision.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/ActOnAssistantActionRequest
  - term: StartAssistantChatResponse
    definition: Returned when a `POST /v1/assistants` call is accepted. Poll `messageId` for the pending assistant reply; keep `assistantId` /
      `projectId` to continue the chat and address the project.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/StartAssistantChatResponse
  - term: SendAssistantMessageResponse
    definition: Returned when a `POST /v1/assistants/{assistantId}/messages` call is accepted. Use `messageId` to poll the pending assistant reply.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/SendAssistantMessageResponse
  - term: ActOnAssistantActionResponse
    definition: Returned when a `POST /v1/assistants/{assistantId}/actions/{actionId}` call is accepted. Use `messageId` to poll the resulting
      assistant message.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/ActOnAssistantActionResponse
  - term: AssistantMessageStatus
    definition: Lifecycle status of an assistant chat message. `pending` and `running` are in-progress; `succeeded`, `failed`, and `cancelled`
      are terminal.
    tags:
    - Enumeration
    source: openapi/videogen-io-openapi.json#/components/schemas/AssistantMessageStatus
  - term: AssistantActionKind
    definition: Normalized category of an actionable widget the assistant offered. `APPROVE_PLAN` accepts a proposed generation plan; `APPLY_EDIT`
      applies a proposed edit (e.g. a rewritten script); `RUN_TOOL` runs an inline tool; `GENERATE` starts building the video; `OPEN_IN_APP` requires
      the full web app — open the assistant's `projectUrl` instead of acting via the API.
    tags:
    - Enumeration
    source: openapi/videogen-io-openapi.json#/components/schemas/AssistantActionKind
  - term: AssistantWorkflowSuggestion
    definition: A starting-point workflow the assistant suggests for the conversation. Act on it with `POST /v1/assistants/{assistantId}/actions/{actionId}`
      to select the workflow and continue.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/AssistantWorkflowSuggestion
  - term: AssistantActionDetail
    definition: 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 action's kind; all are optional.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/AssistantActionDetail
  - term: AssistantAction
    definition: An actionable widget the assistant offered on this turn. Act on it with `POST /v1/assistants/{assistantId}/actions/{actionId}`
      unless `requiresApp` is true.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/AssistantAction
  - term: AssistantMessageAttachment
    definition: A file linked to an assistant chat message.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/AssistantMessageAttachment
  - term: AssistantInputMessage
    definition: A user-authored message in an assistant chat.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/AssistantInputMessage
  - term: AssistantOutputMessage
    definition: An assistant-authored message in an assistant chat, including any suggestions or actions it offered.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/AssistantOutputMessage
  - term: AssistantMessage
    definition: A single message in an assistant chat. Discriminated by `role`.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/AssistantMessage
  - term: GetAssistantResponse
    definition: An assistant chat and every message it currently contains.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/GetAssistantResponse
  - term: GenerateImageRequest
    definition: 'Object declared by the contract with fields: prompt, imageFileIds, entityIds, aspectRatio, quality, contentPolicyConfig, watermarkMode,
      numResults, isOutputTemporary, hideFromUi.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/GenerateImageRequest
  - term: GenerateVideoClipRequest
    definition: At least one of `prompt`, `startFrameFileId`, `imageFileIds`, `videoFileIds`, `audioFileIds`, or `spokenDialogue` must be provided.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/GenerateVideoClipRequest
  - term: GenerateMotionGraphicRequest
    definition: 'Object declared by the contract with fields: prompt, fileIds, entityIds, durationSeconds, aspectRatio, transparentBackground,
      subToolModes, numResults, isOutputTemporary, hideFromUi.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/GenerateMotionGraphicRequest
  - term: MotionGraphicSubToolMode
    definition: Access mode for a motion graphic capability. AUTO uses the capability only when it is available on your plan (generated video
      clips require a paid plan). ENABLED forces the capability on and returns an upgrade error if your plan lacks it. DISABLED prevents the motion
      graphic from using the capability.
    tags:
    - Enumeration
    source: openapi/videogen-io-openapi.json#/components/schemas/MotionGraphicSubToolMode
  - term: MotionGraphicSubToolModes
    definition: Per-capability access modes for a motion graphic. Any omitted capability defaults to AUTO.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/MotionGraphicSubToolModes
  - term: PronunciationReplacement
    definition: 'Object declared by the contract with fields: original, replacement.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/PronunciationReplacement
  - term: TextToSpeechRequest
    definition: 'Object declared by the contract with fields: ttsText, voiceId, speechLanguageCode, pronunciationReplacements, autoExpandPronunciationReplacements,
      voiceSpeed, numResults, isOutputTemporary, hideFromUi.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/TextToSpeechRequest
  - term: GenerateSoundEffectRequest
    definition: 'Object declared by the contract with fields: prompt, durationSeconds, promptInfluence, numResults, isOutputTemporary, hideFromUi.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/GenerateSoundEffectRequest
  - term: GenerateMusicRequest
    definition: 'Object declared by the contract with fields: prompt, numResults, isOutputTemporary, hideFromUi.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/GenerateMusicRequest
  - term: GenerateAvatarRequest
    definition: Generate a talking-head avatar from an ACTOR entity and audio.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/GenerateAvatarRequest
  - term: ImageAssetRequest
    definition: 'Object declared by the contract with fields: imageFileId, watermarkMode, numResults, isOutputTemporary, hideFromUi.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/ImageAssetRequest
  - term: ModelQuality
    definition: AI generation quality tier, shared across every generative feature (image, video, text, and so on). `LOW` is fastest and cheapest,
      `STANDARD` balances quality and cost, `HIGH` is higher quality, and `MAX` is the highest quality. When a request omits the quality field,
      VideoGen falls back to your account's **Default AI quality** for that feature, which you can change at [Account settings](https://a
    tags:
    - Enumeration
    source: openapi/videogen-io-openapi.json#/components/schemas/ModelQuality
  - term: VideoAssetRequest
    definition: 'Object declared by the contract with fields: videoFileId, watermarkMode, numResults, isOutputTemporary, hideFromUi.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/VideoAssetRequest
  - term: StartToolExecutionResponse
    definition: Returned when a tool execution is started. Use `toolExecutionId` to poll for results or cancel.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/StartToolExecutionResponse
  - term: JobStatus
    definition: Lifecycle status shared by every asynchronous job (tool executions, workflow runs, remix actions, project exports, and timeline
      interchange jobs). `pending` and `running` are in-progress; `succeeded`, `failed`, and `cancelled` are terminal.
    tags:
    - Enumeration
    source: openapi/videogen-io-openapi.json#/components/schemas/JobStatus
  - term: ToolSuccessResult
    definition: Result for a single generated file. Only appears inside a succeeded execution's `results`, so every field below is always present.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/ToolSuccessResult
  - term: ErrorRequirement
    definition: 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).
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/ErrorRequirement
  - term: ApiError
    definition: '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 carries the details: - `400` invalid request, `401` missing or invalid API key, `403` not permitted (e.g. plan
      or add-on required, see `requirement`), `404` not found, `409` conflict, `429` rate limited or out of credits, `5xx` server error. '
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/ApiError
  - term: ExecutedTool
    definition: 'Object declared by the contract with fields: toolExecutionId, status, toolType, progressPercentage, attemptIndex, results, error.'
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/ExecutedTool
  - term: ToolExecutionListResponse
    definition: Paginated list of API-started tool executions, most recently created first.
    tags:
    - Object
    source: openapi/videogen-io-openapi.json#/components/schemas/ToolExecutionListResponse
  - term: ToolExecutionWebhookEventName
    definition: Webhook event types for tool execution lifecycle.
    tags:
    - Enumeration
    source: openapi/videogen-io-openapi.json#/components/schemas/ToolExecutionWebhookEventName
  - term: WorkflowRunWebhookEventName
    definition: Lifecycle events emitted for workflow runs started via the developer API.
    tags:
    - Enumeration
    source: openapi/videogen-io-openapi.json#/components/schemas/WorkflowRunWebhookEventName
  - term: ProjectExportWebhookEventName
    definition: Lifecycle events emitted for project exports started via the developer API (`POST /v1/projects/{projectId}/export`).
    tags:
    - Enumeration
    source: openapi/videogen-io-openapi.json#/components/schemas/ProjectExportWebhookEventName