Ler um modelo de campanha
const url = 'https://api.brasilsintetico.com/v1/biblioteca/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.brasilsintetico.com/v1/biblioteca/example \ --header 'Authorization: Bearer <token>'Um modelo: o plano, as premissas e as perguntas sugeridas. Com um lugar (uf, municipio ou os dois), também o pedido para ele (pedido), conferido como a cotação confere.
Autorizações
Seção intitulada “Autorizações”Parâmetros
Seção intitulada “Parâmetros”Parâmetros de caminho
Seção intitulada “Parâmetros de caminho”O id do modelo, como a biblioteca o lista
O id do modelo, como a biblioteca o lista
Parâmetros de consulta
Seção intitulada “Parâmetros de consulta”Uma UF do lugar, pela sigla de duas letras; por padrão, as UFs dos municípios dados
Um município do lugar, pelo código IBGE de 7 dígitos
Respostas
Seção intitulada “Respostas”Resposta bem-sucedida
object
O id do modelo, para GET /v1/biblioteca/{modelo}
O setor para o qual o modelo foi escrito
O que o modelo ajuda a decidir
As premissas do modelo em palavras simples: o público, os canais com os dias e a intensidade, o horizonte. Um modelo traz premissas, não resultados
nao_calibrado: a recepção da mensagem ainda não foi calibrada contra dados reais, e um job feito do modelo diz isso
Um pedido de campanha sem o lugar e sem o que a plataforma preenche: geografia, release, mensagem, grupo_comparacao, nome e horizonte.data_inicio
object
Perguntas sugeridas do contrato de resposta, cada uma com texto, a redação dela; o território e o público vêm com o lugar
object
O que cada modelo diz de si
Exemplo gerado
{ "id": "example", "setor": "example", "nome": "example", "para_que_serve": "example", "premissas": [ "example" ], "calibracao": "example", "cenario": {}, "perguntas": [ {} ], "aviso": "example", "pedido": {}}Erro de validação
object
object
object
Exemplo gerado
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example", "input": "example", "ctx": {} } ]}