taskType SOCIAL com platform youtube e escolha o que ler com action. Cada requisição concluída custa 0.5 crédito.
Requisição
GET /v1/async/task/{id} ou receba o webhook. Veja Tarefas assíncronas.
Ações
videoId aceita um ID de vídeo ou um URL de vídeo do YouTube (exibição, youtu.be, Shorts ou incorporado). channel aceita um ID de canal (UC...), um @handle ou um URL de canal.
Parâmetros
search e recent:
query: Obrigatório. A consulta de pesquisa.limit: Inteiro opcional de 1 a 50, com padrão 10.type:video(padrão),all,shorts,channel,playlistoumovie.order:relevance(padrão),viewCount,dateourating.datelista os envios do mais novo ao mais antigo, comorecent.ratingordena por curtidas os resultados mais vistos do YouTube. Pesquisas dechanneleplaylistaceitamrelevanceouviewCount.publishedAfter: Um horário ISO 8601, como2026-11-01T00:00:00Z. Retorna os vídeos publicados depois dele.videoDuration:short(menos de 3 minutos),medium(de 3 a 20 minutos) oulong(mais de 20 minutos).features: Qualquer um delive,4k,hd,subtitles,creative_commons,360,vr180,3d,hdr,locationepurchased, como array ou como string separada por vírgulas.exactSpelling:truepesquisa a consulta como foi escrita, sem a correção ortográfica do YouTube.pageToken: OnextPageTokenda página anterior. Pesquisas de vídeos ordenadas porrelevanceouviewCountsempublishedAfterretornam um, e cada página pula todos os vídeos que as páginas anteriores retornaram.regionCodeelanguageCode: A região do YouTube (US,KR,JP) e o idioma da interface (en,ko,ja) da pesquisa.
comments:
limit: Inteiro opcional de 1 a 500, com padrão 100. As respostas contam para o limite.order:relevance(padrão, os principais comentários do YouTube) outime(os mais novos primeiro).includeReplies: Opcional, com padrãotrue.
channel_videos:
tab:videos(padrão),shortsoustreams.sort:latest(padrão),popularouoldest.limit: Inteiro opcional de 1 a 50, com padrão 20.
transcript:
languages: Idiomas de legenda em ordem de preferência, como["en", "ko"]. Sem ele, são lidas as legendas padrão do vídeo, depois as em inglês e depois a primeira faixa.isGenerated:truelê só legendas automáticas, efalse, só as legendas de quem enviou o vídeo.trackName: O nome da faixa de legendas a ler.translateTo: Um código de idioma. O YouTube traduz as legendas para ele.maxSegments: Inteiro opcional de 1 a 5.000, com padrão 2.000.
Exemplo de resposta
Campos do resultado
- Toda resposta repete
platformeaction. As listas trazemreturnedCount. searcherecentretornamvideos. Cada vídeo temposition,videoId,url,title,description, os campos do canalchannelId,channelTitle,channelHandle,channelUrl,channelThumbnailechannelIsVerified,publishedAt,publishedTimeText,duration(ISO 8601),durationSeconds,viewCount,likeCount,category,thumbnails,richThumbnail(a prévia animada),badgeseisFamilySafe. Um filme acrescentamoviecom pôster, gênero, ano, elenco e diretor.- Uma pesquisa também retorna os
channels,playlists,shortseshelvesque a página de resultados mostra,totalResults(a estimativa do YouTube) edidYouMeanoushowingResultsForquando o YouTube corrige a consulta. videoacrescentatags,commentCount,subscriberCount,hasCaptions,chapters,mostReplayed,music,descriptionLinkserelatedVideos. Os capítulos de quem enviou vêm primeiro, e os capítulos automáticos trazemautoGenerated: true.commentsretornacomments, cada um comcommentId,parentId(nullem um comentário de nível superior),text,authorDisplayName,authorChannelId,authorProfileImageUrl,authorIsVerified,authorIsChannelOwner,isPinned,isHearted,likeCount,replyCount,publishedAteupdatedAt.totalCounté a contagem que o YouTube mostra, etopLevelCountereplyCountdividemreturnedCount.channelretornachannelId,title,handle,description,country,publishedAt,subscriberCount,videoCount,viewCount,isVerified,keywords,links,thumbnails,bannerUrl,rssUrleuploadsPlaylistId.channel_videosretornavideosna ordem desort, com ochannelIde ochannelTitledo canal.transcriptretorna otextda legenda, ossegmentscom tempos (startedurationem segundos), olanguagelido e osavailableLanguages.truncated: truemarca uma transcrição cortada emmaxSegments.- Um vídeo com curtidas ocultas traz
likesHidden: true, e um com comentários desativados trazcommentsDisabled: true. Um vídeo só para membros trazmembersOnly: truee não temviewCount. - Um vídeo, canal ou faixa de legendas que não existe, ou que exige um espectador conectado, como um vídeo com restrição de idade, encerra a tarefa com
PAGE_UNAVAILABLE. Parâmetros que não combinam entre si a encerram comBAD_PAYLOAD. Só as requisições concluídas são cobradas.