Workflows

List available workflows

Changed on

List all available workflow types with their input/output schemas.

get/v1/workflows

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v1/workflows
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Response

Successful response

has_moreboolean

Whether more pages are available

next_tokenstring nullable

Opaque cursor for the next page

Example response

{
  "data": [
    {
      "workflow_type": "GenerateVideoNode",
      "name": "Generate Video",
      "description": "Generate a video from text and avatar",
      "category": "content_ai",
      "input_schema": {
        "properties": {
          "text": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "output_schema": {
        "properties": {
          "url": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  ]
}

Changes