Opções de resposta: Markdown, respostas brutas e flags include

payload.include adiciona campos opcionais à resposta de uma tarefa. Cada flag é um booleano, e cada mecanismo respeita só algumas delas.

{
  "taskType": "PERPLEXITY",
  "payload": {
    "prompt": "best CRM for a small team",
    "country": "US",
    "include": { "markdown": true, "rawResponse": true }
  }
}

Flags

Flag	Adiciona
`markdown`	A resposta em Markdown, em `markdown` (`aioverview.markdown` no `GOOGLE` e no `BING_SEARCH`).
`rawResponse`	A saída bruta do mecanismo, como `rawResponse` ou `rawContent` (veja abaixo).
`searchQueries`	As buscas que o mecanismo fez, em `searchQueries`.
`ads`, `shopping`	Anúncios e cartões de produto. Só no `CHATGPT`.
`html`	A tela que o mecanismo mostrou. Veja Páginas HTML.
`analysis`	Marcas, recomendações, sentimento e tipos de fonte. Veja Análise da resposta.
`entityDetails`	O painel de detalhes de cada cartão da resposta, grátis. Só no `CHATGPT`. Veja ChatGPT.
`citationAnalysis`	Uma Citation Analysis da resposta. Veja abaixo.

Matriz de suporte

✓ respeitada, sempre retornado sem a flag, — sem efeito (ignorada), ✗ recusada.

taskType	`markdown`	`rawResponse`	`searchQueries`	`html`	`analysis`	`citationAnalysis`
`CHATGPT`	✓ (ligada por padrão)	✓	✓ (ligada por padrão)	✓	✓	✓
`GEMINI`	✓	✓	—	✓	✓	✓
`PERPLEXITY`	✓	✓	✓	✓	✓	✓
`GOOGLE`	✓	✓ `rawContent`	—	✓	✓	✓
`AIMODE`	sempre	✓ `rawContent`	—	✓	✓	✓
`BING_COPILOT`	✓	✓	sempre	✗	✗	✓
`NAVER_AI_BRIEF`	sempre	✓ `rawContent`	—	✗	✓	✓
`NAVER_AI_TAB`	sempre	✓ `rawContent`	—	✗	✓	✓
`META_AI`	sempre	✓	sempre	✓	✗	✗
`QWEN`	sempre	✓	sempre	✗	✗	✗
`DOUBAO`	sempre	✓	sempre	✗	✗	✗
`GOOGLE_SERP`	—	✓ `rawContent`	—	✗	✗	✗
`BING_SEARCH`	✓	✓ `rawContent`	—	✗	✗	✓
`NAVER_SERP`, `COMMERCE_SERP`, `COMMERCE_PRODUCT`, `REDDIT`, `WEB_SCRAPE`, `WEB_MAP`, `WEB_CRAWL`, `KEYWORD_VOLUME`	—	—	—	✗	✗	✗

ads e shopping funcionam só no CHATGPT, onde vêm ligadas por padrão; todos os outros mecanismos as ignoram. searchQueries marcado como “sempre” significa que o mecanismo retorna o campo com ou sem a flag.

Markdown sem flag

AIMODE, NAVER_AI_BRIEF, NAVER_AI_TAB, META_AI, QWEN e DOUBAO retornam markdown em toda resposta. Para esses mecanismos, o Markdown é o formato real da resposta (títulos, listas, tabelas e cartões no lugar), e não uma cópia de text. O CHATGPT também o retorna por padrão; envie "markdown": false para removê-lo. O GOOGLE também aceita a flag antiga include.aioverview.markdown, que faz o mesmo que include.markdown.

Respostas brutas

rawResponse vem desligada por padrão em todos os mecanismos, inclusive no CHATGPT. A saída bruta chega em um de dois campos:

rawResponse: um array de eventos de stream já interpretados (CHATGPT, GEMINI, PERPLEXITY, BING_COPILOT, META_AI, QWEN, DOUBAO).
rawContent: uma string. Em GOOGLE, AIMODE, GOOGLE_SERP e BING_SEARCH, é o HTML completo da página de resultados renderizada; em NAVER_AI_BRIEF e NAVER_AI_TAB, é o stream de eventos original do Naver.

Esses campos chegam a centenas de KB, então peça-os só quando precisar.

Flags não suportadas

O que acontece depende da flag:

Flag	Em um mecanismo que não a suporta
`markdown`, `rawResponse`, `searchQueries`, `ads`, `shopping`	Ignorada em silêncio. Sem erro e sem campo.
`html`	`422 EVIDENCE_UNSUPPORTED`.
`analysis`	`422 VALIDATION_ERROR` em `payload.include.analysis`.
`citationAnalysis`	`400 VALIDATION_ERROR` em `payload.include.citationAnalysis`.
`entityDetails`	`422 VALIDATION_ERROR` em `payload.include.entityDetails`.
`screenshot`	`400 VALIDATION_ERROR` em todos os mecanismos. Não está mais disponível; use `html`.

html, screenshot e citationAnalysis precisam ser booleanos (caso contrário, 400 VALIDATION_ERROR), assim como analysis (422 VALIDATION_ERROR). Todas as recusas acontecem no envio, antes de qualquer reserva de créditos.

Citation Analysis

include.citationAnalysis: true inicia uma Citation Analysis da resposta assim que ela é concluída. É uma tarefa separada e cobrada; o webhook da resposta espera por ela, e as leituras a incluem em response.citationAnalysis. Funciona em CHATGPT, GEMINI, PERPLEXITY, GOOGLE, AIMODE, BING_SEARCH, BING_COPILOT, NAVER_AI_BRIEF e NAVER_AI_TAB. A chave de API também precisa ter permissão para enviar CITATION_ANALYSIS (caso contrário, 403). Veja Citation Analysis para o resultado e o preço.

Primeiros passos

Conceitos principais

Mecanismos de resposta

Busca e dados da web

Opções de requisição

Pesquisa

Monitoramento GEO

Conta e dados

Opções de resposta: Markdown, respostas brutas e flags include

Flags

Matriz de suporte

Markdown sem flag

Respostas brutas

Flags não suportadas

Citation Analysis

Relacionados

​Flags

​Matriz de suporte

​Markdown sem flag

​Respostas brutas

​Flags não suportadas

​Citation Analysis

​Relacionados

Flags

Matriz de suporte

Markdown sem flag

Respostas brutas

Flags não suportadas

Citation Analysis

Relacionados