Pular para o conteúdo
Brasil SintéticoBrasil SintéticoBrasil Sintético

Cotar uma calibração

POST
/v1/calibracoes/estimate
curl --request POST \
  --url https://api.brasilsintetico.com/v1/calibracoes/estimate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "pedido": "example", "serie": [ {} ], "serie_sha256": "example" }'

Confere o pedido e a série e cota a calibração sem reservar nada (a tarifa da simulação sobre cada rodada que ela faz).

Autorizações

Seção intitulada “Autorizações”

Corpo da requisiçãoobrigatório

Seção intitulada “Corpo da requisiçãoobrigatório”
Tipo de mídiaapplication/json
object
pedido
obrigatório
Pedido de calibração

O pedido de calibração sem serie.sha256, que a plataforma calcula a partir das linhas; o JSON Schema dele está em GET /v1/schemas/pedido-calibracao

object
versao_contrato
obrigatório
Valor aceito: 3
cenario
obrigatório
object
versao_contrato
obrigatório
Valor aceito: 3
release
obrigatório
string
/^v[0-9]+\.[0-9]+\.[0-9]+$/
familia
obrigatório
Valores aceitos: adocao recepcao
geografia
obrigatório
object
ufs
obrigatório
Array
>= 1 itens itens únicos
Valores aceitos: AC AL AM AP BA CE DF ES GO MA MG MS MT PA PB PE PI PR RJ RN RO RR RS SC SE SP TO
municipios
Array<string>
itens únicos
aps
Array<string>
itens únicos
publico
object
idades
Array<array>
sexos
Array
itens únicos
Valores aceitos: masculino feminino
niveis_instrucao
Array
itens únicos
Valores aceitos: fundamental_incompleto fundamental_completo medio_completo superior_completo
faixas_renda
Array<integer>
itens únicos
racas
Array
itens únicos
Valores aceitos: branca preta amarela parda indigena
canais
Array<object>
object
canal
obrigatório
Valores aceitos: digital tv radio exterior
dia_inicio
obrigatório
integer
>= 1 <= 65535
dia_fim
obrigatório
integer
>= 1 <= 65535
intensidade
obrigatório
number
> 0 <= 1
mensagem
Qualquer um de:
null
lancamento
Qualquer um de:
null
horizonte
obrigatório
object
data_inicio
obrigatório
string formato: date
/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
dias
obrigatório
integer
>= 1 <= 65535
replicas
obrigatório
integer
>= 1 <= 20
grupo_comparacao
obrigatório
string
/^[a-z0-9][a-z0-9_.-]{0,63}$/
kpis
obrigatório
Array
>= 1 itens itens únicos
Valores aceitos: adotantes alcance ignora absorve repassa rejeita
nome
string
<= 80 caracteres
descricao
string
<= 500 caracteres
saida_por_setor
boolean
contrato_de_resposta
Qualquer um de:
null
lancamento
object
cenario_base
Valor aceito: calibracao
serie
obrigatório
object
declaracao
obrigatório
object
versao_contrato
obrigatório
Valor aceito: 1
granularidade
obrigatório
Valores aceitos: mes dia
medida
obrigatório
Valores aceitos: novos acumulado
eixos
Array
itens únicos
Valores aceitos: canal grupo_idade sexo renda escolaridade raca
unidade
Valores aceitos: municipio area_ponderacao
sha256

Fica de fora: a plataforma calcula o hash da série a partir das linhas e o escreve aqui

string
/^[0-9a-f]{64}$/
/ /
janela
obrigatório
object
inicio
obrigatório
integer
fim
obrigatório
integer
holdout
obrigatório
object
inicio
obrigatório
integer
fim
obrigatório
integer
parametros
obrigatório
object
>= 1 properties
beta0
object
min
obrigatório
number
max
obrigatório
number
passo
number
> 0
logit_lancamento
object
min
obrigatório
number
max
obrigatório
number
passo
number
> 0
dia_lancamento
object
min
obrigatório
integer
>= 1 <= 65535
max
obrigatório
integer
>= 1 <= 65535
passo
integer
> 0
beta_expo
object
min
obrigatório
number
max
obrigatório
number
passo
number
> 0
amortecimento_saturacao
object
min
obrigatório
number
<= 1
max
obrigatório
number
<= 1
passo
number
> 0
conversao_social
object
min
obrigatório
number
max
obrigatório
number
passo
number
> 0
pesos_canais
object
min
obrigatório
number
max
obrigatório
number
passo
number
> 0
canais
Array
>= 1 itens itens únicos
Valores aceitos: domicilio turma estabelecimento vizinhanca digital
gamma_celulas
object
min
obrigatório
number
max
obrigatório
number
passo
number
> 0
agrupamento
Qualquer um de:
Valor aceito: celula
deslocamento_porte
object
min
obrigatório
number
>= -5 <= 5
max
obrigatório
number
>= -5 <= 5
passo
number
> 0
holdout_espacial
object
metodo
obrigatório
Valores aceitos: plataforma cliente nenhum
municipios
Array<string>
>= 1 itens itens únicos
busca
obrigatório
object
metodo
obrigatório
Valores aceitos: grade aleatoria sequencial
candidatos
integer
>= 1 <= 10000
replicas
integer
>= 1 <= 20
serie
Qualquer um de:
Array<object>
<= 150000 itens
object
key
propriedades adicionais
any
serie_sha256
Qualquer um de:
string

Respostas

Seção intitulada “Respostas”

200

Seção intitulada “200”

Resposta bem-sucedida

Tipo de mídiaapplication/json
object
release
obrigatório
string
ufs
obrigatório
Array<string>
dias
obrigatório

Dias simulados, até o último dia do teste fora da amostra

integer
rodadas
obrigatório

As rodadas que o preço cobre: os candidatos da busca, duas por parâmetro livre para a análise do que a série consegue distinguir, e a escolhida

integer
replicas
obrigatório
integer
pessoa_dias
obrigatório
integer
preco_micros
obrigatório

O preço em milionésimos de real

integer
minutos_estimados
obrigatório

Quanto tempo, mais ou menos, a calibração roda depois de começar, em minutos

integer

Exemplo gerado

{
  "release": "example",
  "ufs": [
    "example"
  ],
  "dias": 1,
  "rodadas": 1,
  "replicas": 1,
  "pessoa_dias": 1,
  "preco_micros": 1,
  "minutos_estimados": 1
}

422

Seção intitulada “422”

Erro de validação

Tipo de mídiaapplication/json
object
detail
Array<object>
object
loc
obrigatório
Local
Array
msg
obrigatório
Mensagem
string
type
obrigatório
Tipo do erro
string
input
ctx
Contexto
object

Exemplo gerado

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}