Pular para o conteúdo
Cérebro

Listar documentos do Cérebro

v1.0.0
GEThttps://api.staging.growthaisystem.com/api/v1/cerebro/documentos
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposcerebro.read

Só documentos com versão aprovada vigente. pasta filtra pela chave da pasta (empresa, oferta, servicos…).

Parâmetros de consulta

Vão na querystring, depois do ?.

  • pastastringopcional

    Chave da pasta (empresa, oferta, servicos, objecoes, …).

    • regex "^[a-z0-9_-]{1,40}$"
  • cursorstringopcional
  • limitintegeropcional
    • padrão 20
    • faixa 1–50

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Documentos ativos do Cérebro (classe empresa ou pesquisa, visibilidade de todos), em ordem de criação, com o cursor da próxima página em nextCursor.

  • Cada item — V1CerebroDocumentoResumo

    • idstring
    • titulostring
    • slugstring
      • chavestring
      • nomestring
    • classestring
      • um de"empresa""pesquisa"
    • marcastring

      pesquisa = pesquisa de mercado, não é fato da empresa. Trate como contexto, nunca como promessa.

      • um de"nenhuma""pesquisa"
    • versaoNumerointeger

      Número da versão vigente aprovada.

    • valeAtestring | null
    • atualizadoEmstring
  • nextCursorstring | null

    Cursor opaco da PRÓXIMA página — passe em ?cursor=. null = acabou a lista.