Apify
Visão geral
Seção intitulada “Visão geral”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.
- Site oficial: https://apify.com/
- Documentação na Composio: docs.composio.dev/toolkits/apify
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza chave de API (API_KEY) para conectar.
Você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
api_key | Sim | Token de API da sua conta Apify, usado para autenticar todas as requisições. |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Acesse apify.com e faça login (ou crie uma conta gratuita).
- Clique no avatar no canto superior direito e vá em Settings.
- No menu lateral, selecione Integrations (ou API & Integrations).
- Localize a seção Personal API tokens e clique em + Create new token.
- Dê um nome ao token (ex.:
squados) e copie o valor gerado.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
Apify. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
- 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.)
Ações disponíveis
Seção intitulada “Ações disponíveis”Executar Actor de forma assíncrona
Seção intitulada “Executar Actor de forma assíncrona”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
actorId | string | Sim | ID do Actor ou formato <usuario>~<nomeActor> (til) ou <usuario>/<nomeActor> (barra), ex.: apify~hello-world. |
body | object | Não | Objeto JSON passado como input para o Actor. Cada Actor tem seu próprio esquema de entrada — verifique a documentação na Apify Store. |
build | string | Não | Tag ou número do build do Actor a executar. |
memory | number | Não | Limite de memória para a execução em megabytes. Deve ser potência de 2, mínimo 128. |
timeout | number | Não | Timeout para a execução em segundos. |
maxItems | number | Não | Número máximo de itens que a execução deve retornar. |
waitForFinish | number | Não | Máximo de segundos que o servidor aguarda o término da execução. Padrão: 0, máximo: 60. |
maxTotalChargeUsd | number | Não | Custo máximo da execução do Actor em USD. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Executar Actor de forma síncrona
Seção intitulada “Executar Actor de forma síncrona”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
actorId | string | Sim | ID do Actor ou formato usuario~nome-actor. |
input | object | Sim | Objeto JSON passado como input para a execução do Actor. |
build | string | Não | Tag ou número do build a executar. |
memory | integer | Não | Limite de memória em MB; potência de dois, mínimo 128. |
timeout | number | Não | Timeout em segundos. Máximo de espera HTTP: 300s. |
maxItems | integer | Não | Número máximo de itens do dataset a retornar. |
outputRecordKey | string | Não | Chave do registro no key-value store padrão a retornar (padrão: OUTPUT). |
maxTotalChargeUsd | number | Não | Custo máximo total em USD para a execução. Para Actors pay-per-result, obrigatório e mínimo $1,00. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica 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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
actorId | string | Sim | ID do Actor ou nome no formato usuario/nome-actor ou usuario~nome-actor. O Actor deve existir na Apify Store. |
input | object | Não | Objeto JSON passado como input para a execução do Actor. Verifique o esquema de entrada exato do Actor antes de chamar. |
build | string | Não | Tag ou número do build do Actor a executar (ex.: beta ou 1.2.345). |
memory | integer | Não | Limite de memória para a execução do Actor em megabytes. |
timeout | integer | Não | Timeout para a execução do Actor em segundos. Zero significa sem timeout. |
format | string | Não | Formato da resposta. Padrão: json. |
limit | integer | Não | Número máximo de itens a retornar. |
offset | integer | Não | Número de itens a pular no início. |
maxItems | integer | Não | Número máximo de itens do dataset cobrados para Actors pay-per-result. |
waitForFinish | integer | Não | Tempo máximo em segundos que o servidor aguarda o término (0-300). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica 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').
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
actorId | string | Sim | ID do Actor ou formato usuario~nome-actor. |
status | string | Não | Filtra para retornar itens apenas de execuções com o status especificado (READY, RUNNING, SUCCEEDED, FAILED, TIMED-OUT, ABORTED). |
format | string | Não | Formato de saída dos itens. Padrão: JSON. |
limit | integer | Não | Número máximo de itens a retornar. A API tem limite de 250.000 itens por requisição. |
offset | integer | Não | Número de itens a pular (paginação). Padrão: 0. |
clean | boolean | Não | Atalho para skipHidden=true e skipEmpty=true. Remove metadados da Apify e itens vazios. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica 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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
runId | string | Sim | Identificador único da execução do Actor. |
format | string | Não | Formato de saída dos itens. Padrão: JSON. |
limit | integer | Não | Número máximo de itens a retornar. |
offset | integer | Não | Número de itens a pular no início (paginação). Padrão: 0. |
clean | boolean | Não | Remove metadados da Apify e itens vazios quando verdadeiro. |
desc | boolean | Não | Se verdadeiro, retorna itens em ordem inversa (mais recente primeiro). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter itens de um dataset
Seção intitulada “Obter itens de um dataset”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
datasetId | string | Sim | Identificador do dataset (ex.: usuario/nomeDataset ou ID do dataset). |
format | string | Não | Formato de saída dos itens. Apenas json é totalmente suportado. |
limit | integer | Não | Número máximo de itens a retornar. Padrão e máximo: 1000. |
offset | integer | Não | Número de itens a pular (paginação). Padrão: 0. |
clean | boolean | Não | Remove metadados da Apify dos itens quando verdadeiro. |
desc | boolean | Não | Se verdadeiro, retorna itens em ordem inversa. |
fields | string | Não | Lista separada por vírgulas de campos a incluir. |
omit | string | Não | Lista separada por vírgulas de campos a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Armazenar dados em um dataset
Seção intitulada “Armazenar dados em um dataset”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
datasetId | string | Sim | ID ou nome do dataset (ex.: usuario/nomeDataset ou ID do dataset). |
data | array | Sim | Array de objetos JSON serializáveis a armazenar no dataset. |
omit | string | Não | Lista separada por vírgulas de campos a excluir ao armazenar os itens. |
fields | string | Não | Lista separada por vírgulas de campos a incluir ao armazenar os itens. |
deduplicate | boolean | Não | Se verdadeiro, desduplicar itens recebidos pelo campo foreignId. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar dataset
Seção intitulada “Criar dataset”APIFY_CREATE_DATASET
Cria um novo dataset. Use quando precisar inicializar ou recuperar um dataset pelo nome.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Não | Nome ú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. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter registro do key-value store
Seção intitulada “Obter registro do key-value store”APIFY_GET_KEY_VALUE_RECORD
Recupera um registro de um key-value store. Use quando precisar buscar um valor específico por chave.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
storeId | string | Sim | ID do key-value store. |
recordKey | string | Sim | Chave do registro a recuperar. |
format | string | Não | Formato desejado do registro recuperado (json, xml, html, text). |
disableRedirect | boolean | Não | Se verdadeiro, não redirecionar para o valor bruto; retornar apenas metadados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Armazenar dados no key-value store
Seção intitulada “Armazenar dados no key-value store”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
storeId | string | Sim | ID do key-value store onde o registro será armazenado. |
recordKey | string | Sim | Chave sob a qual o registro será armazenado ou atualizado. |
recordValue | object | Sim | O objeto JSON a armazenar. Deve ser serializável em JSON. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar chaves do key-value store
Seção intitulada “Listar chaves do key-value store”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
storeId | string | Sim | ID do key-value store ou formato usuario~nome-store. |
limit | integer | Não | Número de chaves a retornar. Máximo: 1000. |
prefix | string | Não | Limita os resultados a chaves que começam com o prefixo especificado. |
exclusiveStartKey | string | Não | Todas as chaves até esta (inclusive) são ignoradas. Usado para paginação. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter detalhes de um Actor
Seção intitulada “Obter detalhes de um Actor”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
actorId | string | Sim | ID do Actor separado por til ou barra (ex.: apify~web-scraper ou apify/web-scraper), ou ID hexadecimal de 24 caracteres. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar Actors do usuário
Seção intitulada “Listar Actors do usuário”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
my | boolean | Não | Se verdadeiro, retorna apenas Actors do próprio usuário. |
desc | boolean | Não | Se verdadeiro, ordena por createdAt decrescente. |
limit | integer | Não | Número máximo de registros a retornar. Padrão e máximo: 1000. |
offset | integer | Não | Número de registros a pular (paginação). Padrão: 0. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Pesquisar Actors na Apify Store
Seção intitulada “Pesquisar Actors na Apify Store”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
search | string | Não | String de busca para filtrar Actors por título, nome, descrição, usuário e readme. Exemplo: web scraper. |
limit | integer | Não | Número máximo de Actors a retornar. Padrão: 10, máximo: 1000. |
offset | integer | Não | Número de Actors a pular (paginação). Padrão: 0. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar Actor
Seção intitulada “Criar Actor”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome único para o novo Actor (1-63 caracteres, letras minúsculas, dígitos e hífens). |
title | string | Não | Título legível para o Actor. |
description | string | Não | Descrição detalhada do que o Actor faz. |
isPublic | boolean | Não | Se 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. |
versions | array | Não | Definição das versões iniciais do Actor. |
categories | array | Não | Lista de IDs de categorias às quais o Actor pertence. |
defaultRunOptions | object | Não | Opções de execução padrão para o Actor. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Compilar Actor
Seção intitulada “Compilar Actor”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
actorId | string | Sim | ID do Actor ou nome separado por til (ex.: janedoe~my-actor). |
tag | string | Não | Tag de versão opcional para o build. |
versionNumber | string | Não | Versão do Actor a compilar (ex.: 0.1). Se não fornecido, usa a versão mais recente. |
useCache | boolean | Não | Se verdadeiro, usa camadas em cache de builds anteriores. Padrão: true. |
waitForFinish | integer | Não | Timeout em segundos para aguardar a conclusão do build. Máximo: 300 segundos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter detalhes de uma execução
Seção intitulada “Obter detalhes de uma execução”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
runId | string | Sim | Identificador único da execução do Actor. |
waitForFinish | integer | Não | Segundos máximos para aguardar a conclusão antes de retornar a resposta. Faixa: 0-60. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Abortar execução de Actor
Seção intitulada “Abortar execução de Actor”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
runId | string | Sim | Identificador único da execução do Actor a abortar. |
gracefulAbort | boolean | Não | Se 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. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar execuções de um Actor
Seção intitulada “Listar execuções de um Actor”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
actorId | string | Sim | ID do Actor ou nome separado por til (ex.: janedoe~my-actor). |
status | string | Não | Filtra execuções pelo status do ciclo de vida (READY, RUNNING, SUCCEEDED, FAILED, TIMED-OUT, ABORTED). |
desc | boolean | Não | Se verdadeiro, ordena por startedAt decrescente. |
limit | integer | Não | Número máximo de execuções a retornar. Padrão e máximo: 1000. |
offset | integer | Não | Número de execuções a pular (paginação). Padrão: 0. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar tarefa de Actor
Seção intitulada “Criar tarefa de Actor”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da tarefa. Deve conter apenas letras minúsculas, dígitos e hífens (apenas no meio). |
actId | string | Sim | ID ou usuario~nomeActor do Actor ao qual a tarefa será vinculada. |
input | object | Não | Configuração de input para a tarefa. As chaves devem corresponder exatamente ao esquema de entrada do Actor. |
title | string | Não | Título de exibição para a tarefa. |
options | object | Não | Opções de execução da tarefa como memoryMbytes, timeoutSecs, build. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Executar tarefa de forma assíncrona
Seção intitulada “Executar tarefa de forma assíncrona”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
actorTaskId | string | Sim | ID da tarefa ou nome separado por til (ex.: janedoe~my-task). Use til (~), não barra (/). |
body | object | Não | Objeto JSON passado como input para o Actor. |
build | string | Não | Tag ou número do build do Actor a executar. |
memory | number | Não | Limite de memória em megabytes. Deve ser potência de 2, mínimo 128. |
timeout | number | Não | Timeout em segundos. |
waitForFinish | number | Não | Máximo de segundos que o servidor aguarda. Padrão: 0, máximo: 60. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar agendamento
Seção intitulada “Criar agendamento”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
isEnabled | boolean | Sim | Se verdadeiro, o agendamento está habilitado. |
isExclusive | boolean | Sim | Quando verdadeiro, não inicia o Actor ou tarefa se ainda estiver em execução do agendamento anterior. |
cronExpression | string | Sim | Expressão cron usada por este agendamento (ex.: @monthly, @daily, 0 0 * * *). |
name | string | Não | Nome do agendamento (deve ter 3-63 caracteres). |
title | string | Não | Título amigável para exibição do agendamento. |
actions | array | Não | Actors ou tarefas que devem ser executados neste agendamento. |
timezone | string | Não | Fuso horário no formato TZ database (ex.: UTC, America/New_York). Padrão: UTC. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter dados da conta atual
Seção intitulada “Obter dados da conta atual”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.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter limites da conta
Seção intitulada “Obter limites da conta”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.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter uso mensal
Seção intitulada “Obter uso mensal”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.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |