API de busca na web — pesquisa para seu aplicativo Documentação

1. Autenticação

Chame do seu servidor com api-key e Content-Type: application/json headers. Mantenha sua chave privada.

2. Parâmetros de solicitação

As solicitações suportam apenas consulta, contagem e search_lang. query aceita perguntas ou palavras-chave em linguagem natural.

Campo	Tipo	Obrigatório	Descrição
query	string	Sim	Uma pergunta de pesquisa ou palavras-chave. Não deve estar vazio.
count	integer	Não	Contagem de resultados desejados. Omitir ou passar 0 para usar o serviço padrão.
search_lang	string	Não	Idioma de pesquisa, por exemplo zh-hans. O serviço normaliza zh para zh-hans. Clique nesta linha para ver a lista suportada.

3. Chame a API de pesquisa

POSThttps://api.starsg.ai/api/product/websearch/search

Substitua YOUR_API_KEY e defina a consulta para o seu texto de pesquisa. contagem e search_lang são opcionais.

bash

curl -X POST 'https://api.starsg.ai/api/product/websearch/search' \
  -H 'api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "query": "北京今天的天气",
  "count": 5,
  "search_lang": "zh-hans"
}'

Envie um objeto JSON diretamente, sem wrapper de corpo ou /v1 extra.

4. Leia o resultado

Verifique o sucesso primeiro. Em caso de sucesso, leia data.references e data.data; em caso de falha, inspecione errorCode e errorMsg. O conteúdo da web abaixo é ilustrativo.

Resposta de sucesso

json

{
  "success": true,
  "data": {
    "references": [
      {
        "website": "example.com",
        "logo": "https://example.com/favicon.ico",
        "title": "Exemplo de notícias sobre casa inteligente",
        "url": "https://example.com/article",
        "summary": "O resumo dos resultados da pesquisa vai aqui.",
        "published": "",
        "extra": {}
      }
    ],
    "data": [
      "O resumo dos resultados da pesquisa vai aqui."
    ]
  },
  "errorCode": null,
  "errorMsg": null
}

`data.references`	Referências web com títulos, links e resumos.
`data.data`	Lista de texto de resultados, aninhada dentro do objeto de dados externo.
`references[].website / logo`	Nome do site ou domínio e URL do logotipo.
`references[].title / url / summary`	Título do resultado, URL da página original e resumo.
`references[].published / extra`	Data de publicação e informações extras. Pode estar vazio.

success=true com referências e matrizes de dados vazias significa que nenhum resultado válido foi encontrado. Experimente palavras-chave diferentes ou um idioma de pesquisa diferente; não trate isso como uma falha de API.

Resposta de erro

json

{
  "success": false,
  "data": null,
  "errorCode": "PARAM_INVALID",
  "errorMsg": "query is required"
}

Erros comuns e próximos passos

`PARAM_INVALID`	Verifique o JSON e a consulta. Corrija os parâmetros antes de tentar novamente.
`SEARCH_FAILED`	A pesquisa falhou. Tente novamente mais tarde com um limite de tentativas. Para falhas persistentes, salve o tempo de chamada e o identificador de solicitação de suporte.