Skip to main content
POST
/
api
/
v1
/
web_search
Web Search Endpoint
curl --request POST \
  --url https://services.staging.app.dados.rio/eai-agent-surkai/api/v1/web_search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "k": 6,
  "lang": "pt-BR",
  "freshness_days": 2
}'
{
  "summary": "<string>",
  "sources": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Schema da requisição para /web_search.

​
query
string
required

Pergunta ou termos de busca.

​
k
integer
default:6

Número máximo de resultados iniciais.

Required range: 1 <= x <= 20
​
lang
string
default:pt-BR

Idioma preferido para resultados e summary.

​
freshness_days
integer | null

Restringe busca a conteúdos recentes (opcional).

Required range: x >= 1

Response

Successful Response

Schema da resposta retornada pela rota /web_search.

​
summary
string
required

Resumo objetivo que responde à query.

​
sources
string<uri>[]
required

Lista de URLs citadas na resposta.

Maximum length: 8