YouTube Integration — ModuleX AI

Field	Description	Required	Format
YouTube API Key	Your YouTube Data API v3 key from Google Cloud Console	Yes	`AIzaSyXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`

search — Search for videos on YouTube with advanced filtering by channel, date range, duration, category, quality, captions, and live streams.

Parameters

string

required

Search query for YouTube videos

integer

Maximum number of videos to return (1-50) (Default: 5)

string

Page token for pagination (from a previous nextPageToken)

string

Filter results to a specific channel ID (starts with ‘UC’)

string

Only return videos published after this RFC 3339 date (e.g. 2024-01-01T00:00:00Z)

string

Only return videos published before this RFC 3339 date (e.g. 2024-12-31T23:59:59Z)

string

Filter by length: ‘short’ (<4 min), ‘medium’ (4-20 min), ‘long’ (>20 min), ‘any’

string

Sort by: ‘date’, ‘rating’, ‘relevance’ (default), ‘title’, ‘videoCount’, ‘viewCount’

string

Filter by category ID (e.g. ‘10’ Music). Use video_categories to list IDs.

string

Filter by quality: ‘high’ (HD), ‘standard’, ‘any’

string

Filter by captions: ‘closedCaption’ (has captions), ‘none’ (no captions), ‘any’

string

Filter by live status: ‘live’, ‘upcoming’, ‘completed’

string

ISO 3166-1 alpha-2 country code (e.g. ‘US’, ‘GB’, ‘JP’)

string

ISO 639-1 language code for relevance (e.g. ‘en’, ‘es’)

string

Content filtering: ‘moderate’ (default), ‘none’, ‘strict’

Response

{
  "$defs": {
    "SearchItem": {
      "additionalProperties": false,
      "description": "A single video row in ``search``.",
      "properties": {
        "video_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Video Id"
        },
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Title"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "thumbnail": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Thumbnail"
        },
        "channel_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Channel Id"
        },
        "channel_title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Channel Title"
        },
        "published_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Published At"
        },
        "live_broadcast_content": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Live Broadcast Content"
        }
      },
      "title": "SearchItem",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "items": {
      "items": {
        "$ref": "#/$defs/SearchItem"
      },
      "title": "Items",
      "type": "array"
    },
    "total_results": {
      "default": 0,
      "title": "Total Results",
      "type": "integer"
    },
    "next_page_token": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Next Page Token"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchOutput",
  "type": "object"
}

Parameters

string

ISO 3166-1 alpha-2 country code (e.g. ‘US’, ‘GB’, ‘JP’). Defaults to US.

string

Filter by category ID (e.g. ‘10’ Music, ‘20’ Gaming)

integer

Maximum number of trending videos to return (1-50) (Default: 10)

string

Page token for pagination (from a previous nextPageToken)

Response

{
  "$defs": {
    "TrendingItem": {
      "additionalProperties": false,
      "description": "A single video row in ``trending``.",
      "properties": {
        "video_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Video Id"
        },
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Title"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "thumbnail": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Thumbnail"
        },
        "channel_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Channel Id"
        },
        "channel_title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Channel Title"
        },
        "published_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Published At"
        },
        "view_count": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "View Count"
        },
        "like_count": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Like Count"
        },
        "comment_count": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Comment Count"
        },
        "duration": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Duration"
        }
      },
      "title": "TrendingItem",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "items": {
      "items": {
        "$ref": "#/$defs/TrendingItem"
      },
      "title": "Items",
      "type": "array"
    },
    "total_results": {
      "default": 0,
      "title": "Total Results",
      "type": "integer"
    },
    "next_page_token": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Next Page Token"
    }
  },
  "required": [
    "success"
  ],
  "title": "TrendingOutput",
  "type": "object"
}

video_details — Get detailed information about a specific YouTube video including statistics, content details, live streaming info, and metadata.

Parameters

string

required

YouTube video ID (11-character string)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "video_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Video Id"
    },
    "title": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Title"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Description"
    },
    "channel_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Channel Id"
    },
    "channel_title": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Channel Title"
    },
    "published_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Published At"
    },
    "duration": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Duration"
    },
    "view_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "View Count"
    },
    "like_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Like Count"
    },
    "comment_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Comment Count"
    },
    "favorite_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Favorite Count"
    },
    "thumbnail": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Thumbnail"
    },
    "tags": {
      "items": {
        "type": "string"
      },
      "title": "Tags",
      "type": "array"
    },
    "category_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Category Id"
    },
    "definition": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Definition"
    },
    "caption": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Caption"
    },
    "licensed_content": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Licensed Content"
    },
    "privacy_status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Privacy Status"
    },
    "live_broadcast_content": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Live Broadcast Content"
    },
    "default_language": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Default Language"
    },
    "default_audio_language": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Default Audio Language"
    },
    "is_live_content": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Is Live Content"
    },
    "scheduled_start_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Scheduled Start Time"
    },
    "actual_start_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Actual Start Time"
    },
    "actual_end_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Actual End Time"
    },
    "concurrent_viewers": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Concurrent Viewers"
    },
    "active_live_chat_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Active Live Chat Id"
    }
  },
  "required": [
    "success"
  ],
  "title": "VideoDetailsOutput",
  "type": "object"
}

Parameters

string

ISO 3166-1 alpha-2 country code (e.g. ‘US’, ‘GB’, ‘JP’). Defaults to US.

string

Language for category titles (ISO 639-1, e.g. ‘en’). Defaults to English.

Response

{
  "$defs": {
    "VideoCategoryItem": {
      "additionalProperties": false,
      "description": "A single category row in ``video_categories``.",
      "properties": {
        "category_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Category Id"
        },
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Title"
        },
        "assignable": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Assignable"
        }
      },
      "title": "VideoCategoryItem",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "items": {
      "items": {
        "$ref": "#/$defs/VideoCategoryItem"
      },
      "title": "Items",
      "type": "array"
    },
    "total_results": {
      "default": 0,
      "title": "Total Results",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "VideoCategoriesOutput",
  "type": "object"
}

channel_info — Get detailed information about a YouTube channel including statistics, branding, and content details. Provide either channel_id or username.

Parameters

string

Channel ID starting with ‘UC’ (use either channel_id or username)

string

Channel username (use either channel_id or username)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "channel_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Channel Id"
    },
    "title": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Title"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Description"
    },
    "subscriber_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Subscriber Count"
    },
    "video_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Video Count"
    },
    "view_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "View Count"
    },
    "published_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Published At"
    },
    "thumbnail": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Thumbnail"
    },
    "custom_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Custom Url"
    },
    "country": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Country"
    },
    "uploads_playlist_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Uploads Playlist Id"
    },
    "banner_image_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Banner Image Url"
    },
    "hidden_subscriber_count": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Hidden Subscriber Count"
    }
  },
  "required": [
    "success"
  ],
  "title": "ChannelInfoOutput",
  "type": "object"
}

channel_videos — Search for videos from a specific YouTube channel with sorting options.

Parameters

string

required

YouTube channel ID starting with ‘UC’ to get videos from

integer

Maximum number of results to return (1-50) (Default: 10)

string

Sort order: ‘date’, ‘rating’, ‘relevance’, ‘title’, ‘viewCount’ (default ‘date’)

string

Page token for pagination (from a previous nextPageToken)

Response

{
  "$defs": {
    "ChannelVideoItem": {
      "additionalProperties": false,
      "description": "A single video row in ``channel_videos``.",
      "properties": {
        "video_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Video Id"
        },
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Title"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "thumbnail": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Thumbnail"
        },
        "published_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Published At"
        },
        "channel_title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Channel Title"
        }
      },
      "title": "ChannelVideoItem",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "items": {
      "items": {
        "$ref": "#/$defs/ChannelVideoItem"
      },
      "title": "Items",
      "type": "array"
    },
    "total_results": {
      "default": 0,
      "title": "Total Results",
      "type": "integer"
    },
    "next_page_token": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Next Page Token"
    }
  },
  "required": [
    "success"
  ],
  "title": "ChannelVideosOutput",
  "type": "object"
}

channel_playlists — Get all public playlists from a specific YouTube channel.

Parameters

string

required

YouTube channel ID starting with ‘UC’ to get playlists from

integer

Maximum number of results to return (1-50) (Default: 10)

string

Page token for pagination (from a previous nextPageToken)

Response

{
  "$defs": {
    "PlaylistSummary": {
      "additionalProperties": false,
      "description": "A single playlist row in ``channel_playlists``.",
      "properties": {
        "playlist_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Playlist Id"
        },
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Title"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "thumbnail": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Thumbnail"
        },
        "item_count": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Item Count"
        },
        "published_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Published At"
        },
        "channel_title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Channel Title"
        }
      },
      "title": "PlaylistSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "items": {
      "items": {
        "$ref": "#/$defs/PlaylistSummary"
      },
      "title": "Items",
      "type": "array"
    },
    "total_results": {
      "default": 0,
      "title": "Total Results",
      "type": "integer"
    },
    "next_page_token": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Next Page Token"
    }
  },
  "required": [
    "success"
  ],
  "title": "ChannelPlaylistsOutput",
  "type": "object"
}

playlist_items — Get videos from a YouTube playlist. Can be used with a channel's uploads playlist to get all of a channel's videos.

Parameters

string

required

YouTube playlist ID. Use uploads_playlist_id from channel_info to get all channel videos.

integer

Maximum number of results to return (1-50) (Default: 10)

string

Page token for pagination (from a previous nextPageToken)

Response

{
  "$defs": {
    "PlaylistItem": {
      "additionalProperties": false,
      "description": "A single video row in ``playlist_items``.",
      "properties": {
        "video_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Video Id"
        },
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Title"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "thumbnail": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Thumbnail"
        },
        "published_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Published At"
        },
        "channel_title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Channel Title"
        },
        "position": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Position"
        },
        "video_owner_channel_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Video Owner Channel Id"
        },
        "video_owner_channel_title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Video Owner Channel Title"
        }
      },
      "title": "PlaylistItem",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "items": {
      "items": {
        "$ref": "#/$defs/PlaylistItem"
      },
      "title": "Items",
      "type": "array"
    },
    "total_results": {
      "default": 0,
      "title": "Total Results",
      "type": "integer"
    },
    "next_page_token": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Next Page Token"
    }
  },
  "required": [
    "success"
  ],
  "title": "PlaylistItemsOutput",
  "type": "object"
}

comments — Get top-level comments from a YouTube video with author details and engagement metrics.

Parameters

string

required

YouTube video ID (11-character string)

integer

Maximum number of comments to return (1-100) (Default: 20)

string

Order of comments: ‘time’ (newest first) or ‘relevance’ (most relevant first) (Default: relevance)

string

Page token for pagination (from a previous nextPageToken)

Response

{
  "$defs": {
    "CommentItem": {
      "additionalProperties": false,
      "description": "A single top-level comment row in ``comments``.",
      "properties": {
        "comment_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Comment Id"
        },
        "author_display_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Author Display Name"
        },
        "author_channel_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Author Channel Url"
        },
        "author_profile_image_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Author Profile Image Url"
        },
        "text_display": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Text Display"
        },
        "text_original": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Text Original"
        },
        "like_count": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Like Count"
        },
        "published_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Published At"
        },
        "updated_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Updated At"
        },
        "reply_count": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Reply Count"
        }
      },
      "title": "CommentItem",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "items": {
      "items": {
        "$ref": "#/$defs/CommentItem"
      },
      "title": "Items",
      "type": "array"
    },
    "total_results": {
      "default": 0,
      "title": "Total Results",
      "type": "integer"
    },
    "next_page_token": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Next Page Token"
    }
  },
  "required": [
    "success"
  ],
  "title": "CommentsOutput",
  "type": "object"
}

Using

Providers

Building

Tools

YouTube Integration for AI Agents & Workflows

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Brandfetch

Gamma

Hacker News

Links

​Overview

​Authentication

​API Key Authentication

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Brandfetch

Gamma

Hacker News

​Links

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Related integrations

Links