GeckoAPI
Entrar Agendar uma demo

// docs

Docs de Workflows

Guias do recurso de Workflows da GeckoAPI: o que cada template faz, como configurar uma execução no dashboard ou via API key e quais dados você recebe no arquivo final.

Templates ativos

5

Etapas documentadas

19

Formatos de saída

JSON e CSV

Operação

Dashboard e API key

O que é um workflow?

Workflow é um fluxo pronto da GeckoAPI que encadeia múltiplas chamadas, deduplicação e enriquecimento em uma única execução acompanhável pelo dashboard. Em vez de disparar APIs manualmente uma a uma, você escolhe um template, envia os parâmetros de entrada e recebe um artifact final em JSON ou CSV.

1. Template pronto

Cada workflow já define a sequência de etapas, limites operacionais e lógica de deduplicação para um caso de uso específico.

2. Estimativa antes de rodar

O dashboard mostra uma estimativa máxima de créditos antes da criação do run, com breakdown por etapa.

3. Artifact final

Ao final, você baixa um arquivo com metadados do run, resumo operacional e itens finais já prontos para análise, CRM ou enrichments internos.

Como usar no dashboard

  1. PASSO 1

    Selecione o template que melhor representa o seu caso de uso e revise a descrição das etapas.

  2. PASSO 2

    Preencha os campos do formulário. Os templates aceitam listas, números e filtros específicos dependendo do fluxo.

  3. PASSO 3

    Revise a estimativa máxima de créditos e os limites operacionais antes de iniciar a execução.

  4. PASSO 4

    Acompanhe o status do run, o progresso por etapa e os eventos do fluxo enquanto a coleta está em andamento.

  5. PASSO 5

    Baixe o resultado em JSON para preservar a estrutura completa ou em CSV para uso rápido em planilhas e CRMs.

Executar via API key

Os workflows também podem ser disparados fora do dashboard. A autenticação aceita Authorization: Bearer pk_live_... ou X-API-Key: pk_live_.... O contrato público desta v1 cobre criação do run, polling de status e cancelamento cooperativo.

Criar run

POST /v1/workflows/runs

Poll de status

GET /v1/workflows/runs/{runId}/status

Cancelar run

POST /v1/workflows/runs/{runId}/cancel

Criar workflow 
curl -X POST https://api.geckoapi.com.br/v1/workflows/runs \
+  -H "Authorization: Bearer SUA_CHAVE" \
+  -H "Content-Type: application/json" \
+  -d '{
  "templateId": "ifood-store-idp-enrichment",
  "input": {
    "storeUrl": "https://www.ifood.com.br/delivery/curitiba-pr/fire-s-burger-jardim-gisela/cf787eb5-3689-4a46-b43c-2ceda85d1a76",
    "outputFormat": "csv"
  }
}'
Poll de status 
curl https://api.geckoapi.com.br/v1/workflows/runs/wrk_123/status \
+  -H "Authorization: Bearer SUA_CHAVE"
Response de status concluído 
{
  "run": {
    "runId": "wrk_123",
    "templateId": "ifood-store-idp-enrichment",
    "status": "completed",
    "outputFormat": "csv",
    "createdAt": "2026-03-30T12:00:00.000Z",
    "updatedAt": "2026-03-30T12:07:41.000Z",
    "errorSummary": null,
    "artifactFileName": "workflow-run.csv",
    "artifactContentType": "text/csv; charset=utf-8",
    "artifactSizeBytes": 28491,
    "artifactAvailable": true,
    "downloadUrl": "https://puxapp-results-123.s3.us-east-1.amazonaws.com/workflows/user/run/file.csv?...",
    "downloadUrlExpiresAt": "2026-03-30T12:22:41.000Z",
    "progress": {
      "plannedTasks": 22,
      "completedTasks": 22,
      "failedTasks": 0,
      "plannedPlpTasks": 0,
      "completedPlpTasks": 0,
      "failedPlpTasks": 0,
      "plannedPdpTasks": 0,
      "completedPdpTasks": 0,
      "failedPdpTasks": 0,
      "discoveredStores": 0,
      "uniqueStores": 0,
      "steps": []
    }
  }
}
Cancelar workflow 
curl -X POST https://api.geckoapi.com.br/v1/workflows/runs/wrk_123/cancel \
+  -H "Authorization: Bearer SUA_CHAVE"

Cancelar um workflow descarta o acesso ao resultado final e deve ser usado com cautela. A coleta para nos próximos checkpoints do pipeline, então dados parciais podem já ter sido processados internamente, mas um run cancelado não expõe downloadUrl.

O que o arquivo final produz

Metadados do run

Todo artifact inclui o template usado, o input enviado, a correlação do run e o timestamp de geração.

Resumo operacional

Você vê quantas tarefas foram planejadas, concluídas, falharam e quantos registros únicos entraram no output.

Itens finais

A lista items muda conforme o template: pode representar lojas, empresas ou imobiliárias enriquecidas.

Templates disponíveis

iFood Restaurants Enriched

ifood-restaurants-enriched

2 etapas

Busca restaurantes do iFood por keywords e CEPs, pagina os resultados e entrega uma base deduplicada de lojas com os principais dados do merchant.

json csv

iFood Store -> IDP

ifood-store-idp-enrichment

2 etapas

Recebe a URL de uma loja do iFood, percorre o cardapio e enriquece cada item com detailUrl usando a API iFood IDP.

json csv

Google Places -> iFood -> Casa dos Dados

google-places-ifood-cdd-company-enrichment

4 etapas

Parte de buscas no Google Places, valida presenca no iFood, identifica CNPJ e entrega um artifact company-centric com enrichments da Casa dos Dados.

json csv

Zapimoveis -> Google -> Website -> Casa dos Dados

zapimoveis-google-website-cdd-imobiliaria-enrichment

5 etapas

Parte de anuncios no Zapimoveis, consolida imobiliarias unicas, encontra o site oficial, coleta contatos e entrega um artifact com dados da empresa e CNPJ enriquecido.

json csv

Mercado Livre -> Google -> AI -> Website -> Casa dos Dados

mercadolivre-google-website-cdd-seller-enrichment

6 etapas

Parte de produtos no Mercado Livre, consolida vendedores unicos, usa uma escada de buscas no Google, valida sites oficiais com IA e pode usar diretorios de CNPJ como fallback para descobrir empresa e contatos.

json csv
Grátis para sempre

Executar um workflow real?

Abra o dashboard ou use sua API key para estimar créditos, iniciar um run e baixar o artifact final em JSON ou CSV.

Abrir dashboard Ver exemplos de uso
WhatsApp