Conecte um cliente
Primeiro, coloque sua chave na variável de ambienteQUERYING_API_KEY. Obtenha uma em Chaves de API.
- Claude Code
- Codex
- mcp.json
401. Uma chave inválida é informada na primeira chamada de ferramenta, como erro da ferramenta.
Ferramentas
As ferramentas que enviam tarefas custam o mesmo que a chamada equivalente à API. As ferramentas somente leitura são gratuitas.Tarefas e pesquisa
run_prompt e submit_prompt recebem taskType, prompt e, opcionalmente, country, idempotencyKey, include e page (1 a 10, para GOOGLE_SERP e NAVER_SERP). Veja Mecanismos para os mecanismos e seus preços, e Prompt Research para as entradas da pesquisa.
Para COMMERCE_SERP, envie site e query no lugar de prompt, com limit opcional (1 a 40); veja Commerce Search. read_product recebe url e, opcionalmente, country e idempotencyKey; veja Commerce Product.
run_product_lookup recebe product, country e, opcionalmente, competitors, prompts, engines e idempotencyKey; veja Product Lookup. Ela devolve um resumo: por produto, os mecanismos que o mostram, a faixa de preço, os 10 principais vendedores e sites citados e uma linha por mecanismo; por prompt de compra, os produtos que cada mecanismo mostrou ou citou pelo nome. Isso é cerca de um décimo da resposta completa. Passe detail: "full" para obter cada listagem, página citada e id de tarefa.
Monitores GEO
Cada ferramenta de monitor faz uma chamada à API com a sua chave, então propriedade, escopo da chave e limites do plano valem como no REST. Veja Monitoramento GEO.Timeouts
run_prompt, scrape_page, read_product e research_prompts fazem polling até a tarefa terminar. Elas esperam timeoutSeconds (padrão 180, máximo 900). Se a tarefa ainda estiver em execução, a ferramenta retorna um erro TASK_TIMEOUT com o taskId. A tarefa continua sendo executada; chame get_task com esse id para coletá-la.
run_product_lookup faz polling da consulta da mesma forma. Ela espera 210 segundos por padrão para terminar dentro de um timeout de cliente de 240 segundos, e a maioria das consultas termina em 2 a 3 minutos. Se a consulta ainda estiver em execução, a ferramenta devolve um erro LOOKUP_TIMEOUT com o lookupId; chame get_product_lookup com esse id.
Configure o timeout de ferramentas do seu cliente acima de timeoutSeconds. O exemplo do Codex usa tool_timeout_sec = 240 para o padrão de 180 segundos. Se o seu cliente só permite chamadas de ferramenta curtas, use submit_prompt e depois get_task.