https://openai-plugin.heygen.com/.well-known/ai-plugin.json
{
"schema_version": "v1",
"name_for_human": "HeyGen",
"name_for_model": "HeyGen",
"description_for_human": "The best text-to-video tool. Turn any text to videos.",
"description_for_model": "HeyGen allows users to create a video by simply providing a transcript text. The user inputs the text transcript for the speech or voiceover they want to use for the video. The text should be short and concise. Optional properties such as video title, avatar gender, and avatar skintone can be extracted from the user's input, but if they are not present, the model should decide without seeking additional user input. Once the video is requested, a link to the video is provided. Users can view the video from the link after the video has completed processing. It is important to remind users that they may see a loading message in the link if the video is still being processed, and the page will automatically update with the progress. The user should also be informed that the video may take one to five minutes to process, depending on the text length. In case the video fails to create, an error message containing the reason(s) for the failure will be provided.",
"auth": {
"type": "none"
},
"api": {
"type": "openapi",
"url": "https://openai-plugin.heygen.com/openapi.yaml",
"is_user_authenticated": false
},
"logo_url": "https://openai-plugin.heygen.com/logo.png",
"contact_email": "openai-plugin@heygen.com",
"legal_info_url": "https://www.heygen.com/terms"
}https://openai-plugin.heygen.com/openapi.yaml
openapi: 3.0.1
info:
title: HeyGen
description: A tool that allows the user to create a video. The user only needs to provide a transcript text to create a video.
version: "v2"
servers:
- url: https://openai-plugin.heygen.com
paths:
/simple.video.generate:
post:
operationId: generateSimpleAvatarVideo
summary: Generate a simple video with a piece of transcript text.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/generateSimpleAvatarVideoRequest"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/generateSimpleAvatarVideoResponse"
"400":
description: Bad Request. Cannot create a video based on the parameter(s) provided.
content:
application/json:
schema:
$ref: "#/components/schemas/generateSimpleAvatarVideoError"
/presentation.video.generate:
post:
operationId: generatePresentationAvatarVideo
summary: Generate a presentation video with an image and a piece of transcript text.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/generatePresentationAvatarVideoRequest"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/generateSimpleAvatarVideoResponse"
"400":
description: Bad Request. Cannot create a presentation video based on the parameter(s) provided.
content:
application/json:
schema:
$ref: "#/components/schemas/generateSimpleAvatarVideoError"
components:
schemas:
generateSimpleAvatarVideoRequest:
type: object
required:
- text
properties:
text:
type: string
description: The text transcript for the speech/voiceover to the video that the user wants to generate. Should be short and concise.
required: true
title:
type: string
description: A short title for the video that the user wants to generate. Must be very short and concise.
gender:
type: string
description: The gender of the avatar that appears in the user's requested video.
enum:
- male
- female
skintone:
type: string
description: The skin tone of the avatar that appears in the user's requested video.
enum:
- light
- dark
- asian
generateSimpleAvatarVideoResponse:
type: object
properties:
link:
type: string
description: The link for the newly generated video. The user can view the video from the link after the video completed generation.
generateSimpleAvatarVideoError:
type: object
properties:
message:
type: string
description: The error message containing the reason(s) that why the video failed to create.
generatePresentationAvatarVideoRequest:
type: object
required:
- text
- image
properties:
text:
type: string
description: The text transcript for the speech/voiceover to the presentation video that the user wants to generate. Should be short and concise.
required: true
image:
type: string
description: The URL to the image to be shown in the presentation video that the user wants to generate. Must be in jpg/jpeg/png/svg format.
required: true
title:
type: string
description: A short title for the presentation video that the user wants to generate. Must be very short and concise.
gender:
type: string
description: The gender of the avatar that appears in the user's requested presentation video.
enum:
- male
- female
