Pular para o conteúdo

Apify

Apify

Apify é uma plataforma para construir, implantar e gerenciar ferramentas de web scraping e automação chamadas Actors. Com a integração Apify no SquadOS, seus agentes podem executar qualquer Actor publico da Apify Store, armazenar e recuperar dados de datasets e key-value stores, gerenciar tarefas agendadas e automatizar fluxos completos de coleta e processamento de dados na web.

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

CampoObrigatórioDescrição
api_keySimToken de API da sua conta Apify, usado para autenticar todas as requisições.
  1. Acesse apify.com e faça login (ou crie uma conta gratuita).
  2. Clique no avatar no canto superior direito e vá em Settings.
  3. No menu lateral, selecione Integrations (ou API & Integrations).
  4. Localize a seção Personal API tokens e clique em + Create new token.
  5. Dê um nome ao token (ex.: squados) e copie o valor gerado.
  1. Acesse Ferramentas no menu lateral (/admin/tools).
  2. Abra a aba Disponíveis e procure por Apify.
  3. Clique no card para abrir o modal de detalhes e em Conectar.
  4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
  5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

APIFY_RUN_ACTOR

Executa um Actor específico de forma assíncrona. Use quando precisar acionar um Actor sem aguardar o término e obter os detalhes da execução imediatamente.

NomeTipoObrigatórioDescrição
actorIdstringSimID do Actor ou formato <usuario>~<nomeActor> (til) ou <usuario>/<nomeActor> (barra), ex.: apify~hello-world.
bodyobjectNãoObjeto JSON passado como input para o Actor. Cada Actor tem seu próprio esquema de entrada — verifique a documentação na Apify Store.
buildstringNãoTag ou número do build do Actor a executar.
memorynumberNãoLimite de memória para a execução em megabytes. Deve ser potência de 2, mínimo 128.
timeoutnumberNãoTimeout para a execução em segundos.
maxItemsnumberNãoNúmero máximo de itens que a execução deve retornar.
waitForFinishnumberNãoMáximo de segundos que o servidor aguarda o término da execução. Padrão: 0, máximo: 60.
maxTotalChargeUsdnumberNãoCusto máximo da execução do Actor em USD.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_RUN_ACTOR_SYNC

Executa um Actor específico de forma síncrona com input e retorna seu registro de saída. Use quando precisar de resultados imediatos; execuções podem atingir timeout após 300 segundos.

NomeTipoObrigatórioDescrição
actorIdstringSimID do Actor ou formato usuario~nome-actor.
inputobjectSimObjeto JSON passado como input para a execução do Actor.
buildstringNãoTag ou número do build a executar.
memoryintegerNãoLimite de memória em MB; potência de dois, mínimo 128.
timeoutnumberNãoTimeout em segundos. Máximo de espera HTTP: 300s.
maxItemsintegerNãoNúmero máximo de itens do dataset a retornar.
outputRecordKeystringNãoChave do registro no key-value store padrão a retornar (padrão: OUTPUT).
maxTotalChargeUsdnumberNãoCusto máximo total em USD para a execução. Para Actors pay-per-result, obrigatório e mínimo $1,00.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

Executar Actor sincronamente e obter itens do dataset

Seção intitulada “Executar Actor sincronamente e obter itens do dataset”

APIFY_RUN_ACTOR_SYNC_GET_DATASET_ITEMS

Executa um Actor de forma síncrona e recupera os itens do seu dataset. Use quando precisar de acesso imediato aos resultados da execução.

NomeTipoObrigatórioDescrição
actorIdstringSimID do Actor ou nome no formato usuario/nome-actor ou usuario~nome-actor. O Actor deve existir na Apify Store.
inputobjectNãoObjeto JSON passado como input para a execução do Actor. Verifique o esquema de entrada exato do Actor antes de chamar.
buildstringNãoTag ou número do build do Actor a executar (ex.: beta ou 1.2.345).
memoryintegerNãoLimite de memória para a execução do Actor em megabytes.
timeoutintegerNãoTimeout para a execução do Actor em segundos. Zero significa sem timeout.
formatstringNãoFormato da resposta. Padrão: json.
limitintegerNãoNúmero máximo de itens a retornar.
offsetintegerNãoNúmero de itens a pular no início.
maxItemsintegerNãoNúmero máximo de itens do dataset cobrados para Actors pay-per-result.
waitForFinishintegerNãoTempo máximo em segundos que o servidor aguarda o término (0-300).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

Obter itens do dataset da última execução de um Actor

Seção intitulada “Obter itens do dataset da última execução de um Actor”

APIFY_GET_ACTOR_LAST_RUN_DATASET_ITEMS

Obtém itens do dataset da última execução de um Actor. Use quando precisar recuperar dados de saída da execução mais recente, opcionalmente filtrado por status (ex.: status='SUCCEEDED').

NomeTipoObrigatórioDescrição
actorIdstringSimID do Actor ou formato usuario~nome-actor.
statusstringNãoFiltra para retornar itens apenas de execuções com o status especificado (READY, RUNNING, SUCCEEDED, FAILED, TIMED-OUT, ABORTED).
formatstringNãoFormato de saída dos itens. Padrão: JSON.
limitintegerNãoNúmero máximo de itens a retornar. A API tem limite de 250.000 itens por requisição.
offsetintegerNãoNúmero de itens a pular (paginação). Padrão: 0.
cleanbooleanNãoAtalho para skipHidden=true e skipEmpty=true. Remove metadados da Apify e itens vazios.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

Obter itens do dataset de uma execução específica

Seção intitulada “Obter itens do dataset de uma execução específica”

APIFY_GET_RUN_DATASET_ITEMS

Obtém itens do dataset de uma execução específica de um Actor. Use quando precisar recuperar os dados de saída de uma execução concluída ou em andamento.

NomeTipoObrigatórioDescrição
runIdstringSimIdentificador único da execução do Actor.
formatstringNãoFormato de saída dos itens. Padrão: JSON.
limitintegerNãoNúmero máximo de itens a retornar.
offsetintegerNãoNúmero de itens a pular no início (paginação). Padrão: 0.
cleanbooleanNãoRemove metadados da Apify e itens vazios quando verdadeiro.
descbooleanNãoSe verdadeiro, retorna itens em ordem inversa (mais recente primeiro).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_GET_DATASET_ITEMS

Recupera itens de um dataset. Use para buscar dados de um dataset específico com paginação ou filtragem. Para datasets com mais de 1000 itens, faça múltiplas chamadas incrementando offset por limit até a resposta retornar menos itens que o limit.

NomeTipoObrigatórioDescrição
datasetIdstringSimIdentificador do dataset (ex.: usuario/nomeDataset ou ID do dataset).
formatstringNãoFormato de saída dos itens. Apenas json é totalmente suportado.
limitintegerNãoNúmero máximo de itens a retornar. Padrão e máximo: 1000.
offsetintegerNãoNúmero de itens a pular (paginação). Padrão: 0.
cleanbooleanNãoRemove metadados da Apify dos itens quando verdadeiro.
descbooleanNãoSe verdadeiro, retorna itens em ordem inversa.
fieldsstringNãoLista separada por vírgulas de campos a incluir.
omitstringNãoLista separada por vírgulas de campos a excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_STORE_DATA_IN_DATASET

Armazena itens de dados em um dataset. Use após coletar dados quando quiser adicionar ou atualizar itens em lote em um dataset existente.

NomeTipoObrigatórioDescrição
datasetIdstringSimID ou nome do dataset (ex.: usuario/nomeDataset ou ID do dataset).
dataarraySimArray de objetos JSON serializáveis a armazenar no dataset.
omitstringNãoLista separada por vírgulas de campos a excluir ao armazenar os itens.
fieldsstringNãoLista separada por vírgulas de campos a incluir ao armazenar os itens.
deduplicatebooleanNãoSe verdadeiro, desduplicar itens recebidos pelo campo foreignId.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_CREATE_DATASET

Cria um novo dataset. Use quando precisar inicializar ou recuperar um dataset pelo nome.

NomeTipoObrigatórioDescrição
namestringNãoNome único personalizado para o dataset (1-63 caracteres). Deve conter apenas letras minúsculas, dígitos e hífens (apenas no meio). Se omitido, um nome aleatório é gerado.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_GET_KEY_VALUE_RECORD

Recupera um registro de um key-value store. Use quando precisar buscar um valor específico por chave.

NomeTipoObrigatórioDescrição
storeIdstringSimID do key-value store.
recordKeystringSimChave do registro a recuperar.
formatstringNãoFormato desejado do registro recuperado (json, xml, html, text).
disableRedirectbooleanNãoSe verdadeiro, não redirecionar para o valor bruto; retornar apenas metadados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_STORE_DATA_IN_KEY_VALUE_STORE

Cria ou atualiza um registro em um key-value store. Use após ter o ID do store e a chave do registro para persistir dados JSON.

NomeTipoObrigatórioDescrição
storeIdstringSimID do key-value store onde o registro será armazenado.
recordKeystringSimChave sob a qual o registro será armazenado ou atualizado.
recordValueobjectSimO objeto JSON a armazenar. Deve ser serializável em JSON.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_KEY_VALUE_STORE_KEYS_GET

Recupera uma lista de chaves de um key-value store. Use quando precisar enumerar as chaves do store com filtro opcional por prefixo e suporte a paginação.

NomeTipoObrigatórioDescrição
storeIdstringSimID do key-value store ou formato usuario~nome-store.
limitintegerNãoNúmero de chaves a retornar. Máximo: 1000.
prefixstringNãoLimita os resultados a chaves que começam com o prefixo especificado.
exclusiveStartKeystringNãoTodas as chaves até esta (inclusive) são ignoradas. Usado para paginação.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_GET_ACTOR

Obtém detalhes de um Actor específico. Use quando precisar de metadados do Actor por ID ou nome de usuário/nomeActor. A resposta inclui os campos isDeprecated e pricingInfos com custo por unidade — revise ambos antes de agendar execuções.

NomeTipoObrigatórioDescrição
actorIdstringSimID do Actor separado por til ou barra (ex.: apify~web-scraper ou apify/web-scraper), ou ID hexadecimal de 24 caracteres.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_ACTS_GET

Obtém a lista de todos os Actors criados ou usados pelo usuário. Use quando precisar enumerar ou navegar pelos Actors. Adicione my=1 para obter apenas os Actors criados pelo próprio usuário.

NomeTipoObrigatórioDescrição
mybooleanNãoSe verdadeiro, retorna apenas Actors do próprio usuário.
descbooleanNãoSe verdadeiro, ordena por createdAt decrescente.
limitintegerNãoNúmero máximo de registros a retornar. Padrão e máximo: 1000.
offsetintegerNãoNúmero de registros a pular (paginação). Padrão: 0.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_STORE_GET

Obtém a lista de Actors públicos da Apify Store. Use quando precisar navegar ou buscar Actors públicos disponíveis na loja. Suporta pesquisa por título, nome, descrição, usuário e readme.

NomeTipoObrigatórioDescrição
searchstringNãoString de busca para filtrar Actors por título, nome, descrição, usuário e readme. Exemplo: web scraper.
limitintegerNãoNúmero máximo de Actors a retornar. Padrão: 10, máximo: 1000.
offsetintegerNãoNúmero de Actors a pular (paginação). Padrão: 0.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_CREATE_ACTOR

Cria um novo Actor com a configuração especificada. Use quando precisar inicializar um Actor novo de forma programática antes de publicar ou executar.

NomeTipoObrigatórioDescrição
namestringSimNome único para o novo Actor (1-63 caracteres, letras minúsculas, dígitos e hífens).
titlestringNãoTítulo legível para o Actor.
descriptionstringNãoDescrição detalhada do que o Actor faz.
isPublicbooleanNãoSe o Actor deve ser visível publicamente na Apify Store. Não pode ser true na criação — Actors devem ser criados como privados, depois compilados e publicados.
versionsarrayNãoDefinição das versões iniciais do Actor.
categoriesarrayNãoLista de IDs de categorias às quais o Actor pertence.
defaultRunOptionsobjectNãoOpções de execução padrão para o Actor.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_ACT_BUILDS_POST

Compila um Actor com a configuração especificada. Use quando precisar criar um novo build de um Actor para uma versão específica. O processo compila o código-fonte do Actor em uma imagem Docker.

NomeTipoObrigatórioDescrição
actorIdstringSimID do Actor ou nome separado por til (ex.: janedoe~my-actor).
tagstringNãoTag de versão opcional para o build.
versionNumberstringNãoVersão do Actor a compilar (ex.: 0.1). Se não fornecido, usa a versão mais recente.
useCachebooleanNãoSe verdadeiro, usa camadas em cache de builds anteriores. Padrão: true.
waitForFinishintegerNãoTimeout em segundos para aguardar a conclusão do build. Máximo: 300 segundos.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_ACTOR_RUN_GET

Obtém detalhes sobre uma execução específica de um Actor, incluindo status, uso de recursos, IDs de armazenamento e metadados.

NomeTipoObrigatórioDescrição
runIdstringSimIdentificador único da execução do Actor.
waitForFinishintegerNãoSegundos máximos para aguardar a conclusão antes de retornar a resposta. Faixa: 0-60.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_ACTOR_RUN_ABORT_POST

Aborta uma execução de Actor em andamento ou iniciando. Execuções nos estados FINISHED, FAILED, ABORTING e TIMED-OUT não são afetadas.

NomeTipoObrigatórioDescrição
runIdstringSimIdentificador único da execução do Actor a abortar.
gracefulAbortbooleanNãoSe verdadeiro, aborta de forma gradual enviando eventos aborting e persistStates antes de forçar a parada após 30 segundos. Útil quando planeja retomar a execução depois.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_GET_LIST_OF_RUNS

Obtém a lista de execuções de um Actor específico com suporte a paginação e filtragem opcional por status.

NomeTipoObrigatórioDescrição
actorIdstringSimID do Actor ou nome separado por til (ex.: janedoe~my-actor).
statusstringNãoFiltra execuções pelo status do ciclo de vida (READY, RUNNING, SUCCEEDED, FAILED, TIMED-OUT, ABORTED).
descbooleanNãoSe verdadeiro, ordena por startedAt decrescente.
limitintegerNãoNúmero máximo de execuções a retornar. Padrão e máximo: 1000.
offsetintegerNãoNúmero de execuções a pular (paginação). Padrão: 0.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_CREATE_TASK

Cria uma nova tarefa de Actor com as configurações especificadas. Use quando precisar configurar ou agendar execuções recorrentes de um Actor de forma programática.

NomeTipoObrigatórioDescrição
namestringSimNome da tarefa. Deve conter apenas letras minúsculas, dígitos e hífens (apenas no meio).
actIdstringSimID ou usuario~nomeActor do Actor ao qual a tarefa será vinculada.
inputobjectNãoConfiguração de input para a tarefa. As chaves devem corresponder exatamente ao esquema de entrada do Actor.
titlestringNãoTítulo de exibição para a tarefa.
optionsobjectNãoOpções de execução da tarefa como memoryMbytes, timeoutSecs, build.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_RUN_TASK

Executa uma tarefa de Actor de forma assíncrona. Use quando precisar acionar uma execução de tarefa sem aguardar o término e obter os detalhes imediatamente.

NomeTipoObrigatórioDescrição
actorTaskIdstringSimID da tarefa ou nome separado por til (ex.: janedoe~my-task). Use til (~), não barra (/).
bodyobjectNãoObjeto JSON passado como input para o Actor.
buildstringNãoTag ou número do build do Actor a executar.
memorynumberNãoLimite de memória em megabytes. Deve ser potência de 2, mínimo 128.
timeoutnumberNãoTimeout em segundos.
waitForFinishnumberNãoMáximo de segundos que o servidor aguarda. Padrão: 0, máximo: 60.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_SCHEDULES_POST

Cria um novo agendamento com as configurações especificadas. Use quando precisar automatizar a execução de um Actor ou tarefa em horários específicos usando expressões cron.

NomeTipoObrigatórioDescrição
isEnabledbooleanSimSe verdadeiro, o agendamento está habilitado.
isExclusivebooleanSimQuando verdadeiro, não inicia o Actor ou tarefa se ainda estiver em execução do agendamento anterior.
cronExpressionstringSimExpressão cron usada por este agendamento (ex.: @monthly, @daily, 0 0 * * *).
namestringNãoNome do agendamento (deve ter 3-63 caracteres).
titlestringNãoTítulo amigável para exibição do agendamento.
actionsarrayNãoActors ou tarefas que devem ser executados neste agendamento.
timezonestringNãoFuso horário no formato TZ database (ex.: UTC, America/New_York). Padrão: UTC.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_USERS_ME_GET

Obtém informações privadas da conta do usuário atual, incluindo perfil, plano de assinatura e configurações de proxy. Os campos plan, email e profile são omitidos quando acessados a partir de uma execução de Actor.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_USERS_ME_LIMITS_GET

Obtém um resumo completo dos limites e uso da conta, incluindo ciclos de uso, tetos de gastos, recursos de computação, cotas de transferência de dados e outros limites. Exibe as mesmas informações que a página Limits no console da Apify.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

APIFY_USERS_ME_USAGE_MONTHLY_GET

Obtém o uso mensal da conta. Use quando precisar verificar estatísticas de consumo do período atual.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.