taskType SOCIAL with platform youtube, and pick what to read with action. A completed request costs 0.5 credits.
Request
GET /v1/async/task/{id} or receive its webhook. See Async tasks.
Actions
videoId takes a video ID or a YouTube video URL (watch, youtu.be, Shorts or embed). channel takes a channel ID (UC...), an @handle or a channel URL.
Parameters
search and recent:
query: Required. The search query.limit: Optional integer from 1 to 50, default 10.type:video(default),all,shorts,channel,playlistormovie.order:relevance(default),viewCount,dateorrating.datelists uploads newest first, likerecent.ratingsorts YouTube’s most-viewed results by like count.channelandplaylistsearches takerelevanceorviewCount.publishedAfter: An ISO 8601 time, such as2026-11-01T00:00:00Z. Returns videos published after it.videoDuration:short(under 3 minutes),medium(3 to 20 minutes) orlong(over 20 minutes).features: Any oflive,4k,hd,subtitles,creative_commons,360,vr180,3d,hdr,locationandpurchased, as an array or a comma-separated string.exactSpelling:truesearches the query as written, without YouTube’s spelling correction.pageToken: ThenextPageTokenof the previous page. Video searches ordered byrelevanceorviewCountwithoutpublishedAfterreturn one, and each page skips every video the earlier pages returned.regionCodeandlanguageCode: The YouTube region (US,KR,JP) and interface language (en,ko,ja) to search in.
comments:
limit: Optional integer from 1 to 500, default 100. Replies count toward the limit.order:relevance(default, YouTube’s top comments) ortime(newest first).includeReplies: Optional, defaulttrue.
channel_videos:
tab:videos(default),shortsorstreams.sort:latest(default),popularoroldest.limit: Optional integer from 1 to 50, default 20.
transcript:
languages: Caption languages in order of preference, such as["en", "ko"]. Without it, the video’s default captions are read, then English, then the first track.isGenerated:truereads automatic captions only,falsethe uploader’s captions only.trackName: The name of the caption track to read.translateTo: A language code. YouTube translates the captions into it.maxSegments: Optional integer from 1 to 5,000, default 2,000.
Response example
Result fields
- Every response echoes
platformandaction. Lists carryreturnedCount. searchandrecentreturnvideos. Each video hasposition,videoId,url,title,description, the channel’schannelId,channelTitle,channelHandle,channelUrl,channelThumbnailandchannelIsVerified,publishedAt,publishedTimeText,duration(ISO 8601),durationSeconds,viewCount,likeCount,category,thumbnails,richThumbnail(the moving preview),badgesandisFamilySafe. A film addsmoviewith its poster, genre, year, cast and director.- A search also returns the
channels,playlists,shortsandshelvesthe results page shows,totalResults(YouTube’s estimate), anddidYouMeanorshowingResultsForwhen YouTube corrects the query. videoaddstags,commentCount,subscriberCount,hasCaptions,chapters,mostReplayed,music,descriptionLinksandrelatedVideos. The uploader’s chapters come first, and automatic chapters carryautoGenerated: true.commentsreturnscomments, each withcommentId,parentId(nullon a top-level comment),text,authorDisplayName,authorChannelId,authorProfileImageUrl,authorIsVerified,authorIsChannelOwner,isPinned,isHearted,likeCount,replyCount,publishedAtandupdatedAt.totalCountis the count YouTube shows, andtopLevelCountandreplyCountsplitreturnedCount.channelreturnschannelId,title,handle,description,country,publishedAt,subscriberCount,videoCount,viewCount,isVerified,keywords,links,thumbnails,bannerUrl,rssUrlanduploadsPlaylistId.channel_videosreturnsvideosin the order ofsort, with the channel’schannelIdandchannelTitle.transcriptreturns the captiontext, timedsegments(startanddurationin seconds), thelanguageread and theavailableLanguages.truncated: truemarks a transcript cut atmaxSegments.- A video with hidden likes carries
likesHidden: true, and one with comments turned off carriescommentsDisabled: true. A members-only video carriesmembersOnly: trueand noviewCount. - A video, channel or caption track that does not exist, or that needs a signed-in viewer such as an age-restricted video, ends the task with
PAGE_UNAVAILABLE. Parameters that do not fit together end it withBAD_PAYLOAD. Only completed requests are charged.