Growth
Disparar execução
O preço desta operação para a sua conta fica em Configurações → Planos, já com o valor negociado do seu workspace.
O escopo vai no body, no campo module: omitido, roda a execução completa (FULL, os 6 módulos); com um dos 6, só aquele módulo. Preço fixo, cobrado só pelo módulo que entregar.
{}{ "module": "keywords" }| Escopo | module | Créditos |
|---|---|---|
| Concorrentes | competitors | 60 |
| Anúncios | ads | 60 |
| Palavras-chave | keywords | 400 |
| Inspirações | inspirations | 60 |
| Performance do site | performance | 150 |
| Visibilidade nas IAs | ai_visibility | 400 |
| Execução completa (FULL) | omitido | 1.130 |
Inicia a execução do Growth: sem module = execução completa (todas as etapas + diagnóstico + novidades); com module = só as etapas daquele módulo (competitors, ads, keywords, inspirations, performance, ai_visibility), liberado depois de uma execução completa concluída (senão 409 NEEDS_FULL_RUN: dispare a completa, não repita). Mesmo disparo do botão Executar da tela.
Sem disparo duplicado: uma execução ativa por workspace. Chamar de novo durante uma execução devolve a mesma (200, created: false), sem nova reserva; se o module da resposta for diferente do pedido, a ativa é de outro escopo: espere terminar e chame de novo. Execução concluída há menos de 15 minutos que cobre o mesmo escopo (a completa cobre qualquer módulo; um módulo cobre só a si mesmo) volta com recent: true, sem criar nem cobrar; force: true ignora essa janela. Repetir a chamada é seguro: não há header de idempotência porque esses dois guardas já cobrem o retry. O andamento se acompanha em GET /api/v1/growth/data (bloco run, grátis), nunca disparando de novo. Exceção: run.stale: true (travada); aí um novo disparo fecha a travada e cria outra. Se ainda voltar created: false com o mesmo run_id, pare.
Créditos: preço fixo por módulo; a execução completa custa a soma dos seis. Na criação, reserva o preço do escopo em créditos do membro que criou a chave (respeita o limite do membro, o teto do workspace e o bloqueio; recusada = 402, nada criado). No fim, cobra só os módulos que entregaram (o módulo parcial: visibilidade nas IAs, performance, concorrentes ou anúncios, cobra proporcional ao que entregou, nunca acima do preço do módulo) e solta o resto. O valor reservado volta em reserved_credits (na execução ativa ou recente devolvida, o valor real da reserva dela); o preço de cada escopo aparece em run_options de GET /api/v1/growth/data e na tool MCP tamz_get_credits. Exige o módulo Growth ativo no workspace.
Rate limit: 10 req/min por workspace (somado com a tool MCP tamz_growth_run); 429 traz Retry-After.
Testar ao vivo
Autorização
Sua API key, gerada em /developer/api-keys. Gratuita para começar.
Sua requisição
curl -X POST 'https://tamz.ai/api/v1/growth/run' \
-H 'Authorization: Bearer tamz_SUA_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"force": false
}'Corpo da requisição
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Exemplo de retorno
{
"data": {
"run_id": "6f1c2a9e-1b2c-4d5e-8f90-123456789abc",
"status": "done",
"module": "performance",
"steps": [
{
"key": "performance",
"status": "done"
}
],
"reserved_credits": 100,
"created": false,
"recent": true,
"created_at": "2026-11-04T10:00:00.000Z",
"finished_at": "2026-11-04T10:03:00.000Z"
},
"meta": {
"run_id": "6f1c2a9e-1b2c-4d5e-8f90-123456789abc",
"run_status": "done",
"finished_at": "2026-11-04T10:03:00.000Z"
}
}{
"data": {
"run_id": "6f1c2a9e-1b2c-4d5e-8f90-123456789abc",
"status": "queued",
"module": "performance",
"steps": [
{
"key": "performance",
"status": "pending"
}
],
"reserved_credits": 100,
"created": true,
"recent": false,
"created_at": "2026-11-04T10:00:00.000Z",
"finished_at": null
},
"meta": {
"run_id": "6f1c2a9e-1b2c-4d5e-8f90-123456789abc",
"run_status": "queued",
"finished_at": null
}
}{
"error": {
"code": "INVALID_PARAMS",
"message": "Invalid option",
"valid_modules": [
"competitors",
"ads",
"keywords",
"inspirations",
"performance",
"ai_visibility"
]
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Missing API key. Use Authorization: Bearer tamz_xxx or X-API-Key header"
}
}{
"error": {
"code": "INSUFFICIENT_CREDITS",
"message": "The run reservation was refused (credits, member/workspace limit or blocked workspace). Nothing was created.",
"required": 500,
"available": 300
}
}{
"error": {
"code": "MODULE_NOT_ENABLED",
"message": "O módulo Growth não está ativo neste workspace."
}
}{
"error": {
"code": "NEEDS_FULL_RUN",
"message": "A single module runs only after one full run has finished. Start a full run (omit `module`) instead of retrying."
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded",
"retry_after": 42
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "Service temporarily unavailable"
}
}Respostas e códigos
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json