Enviar uma calibração

POST

/v1/calibracoes

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

Reserva o preço cotado e põe a calibração na fila como um job do tipo calibracao; acompanhe com GET /v1/jobs/{id}. O resultado traz o cenário calibrado, a busca e o veredito fora da amostra.

Autorizações

• projectKey

Parâmetros

Parâmetros de cabeçalho

Idempotency-Key

obrigatório

string

>= 1 caracteres <= 200 caracteres

Corpo da requisição^obrigató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

null

object

object

stim_id

obrigatório

string

/^[0-9a-f]{32}$/

template_ver

obrigatório

string

/\S/

politica

obrigatório

string

/\S/

lancamento

Qualquer um de:

null

null

object

object

dia

obrigatório

integer

>= 1 <= 65535

cenario_base

obrigatório

Valores aceitos: pix calibracao

calibracao

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

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

null

object

object

versao

obrigatório

Valor aceito: 1

perguntas

obrigatório

Array

>= 1 itens <= 20 itens itens únicos

Um de:

object

object

id

obrigatório

string

/^[a-z0-9][a-z0-9_-]{0,39}$/

forma

obrigatório

Valores aceitos: quantos quando onde

medida

obrigatório

Valores aceitos: adotantes alcance ignora absorve repassa rejeita adocao exposta_social exposta_midia_medida exposta_midia_declarada exposta_midia_ambas ignora absorve repassa rejeita

publico

object

grupo_idade

Array<integer>

itens únicos

sexo

Array<integer>

itens únicos

renda

Array<integer>

itens únicos

escolaridade

Array<integer>

itens únicos

raca

Array<integer>

itens únicos

faixa_etaria_5

Array<integer>

itens únicos

territorio

obrigatório

Um de:

object

object

municipios

obrigatório

Array<string>

>= 1 itens <= 5000 itens itens únicos

object

object

setores

obrigatório

Array<string>

>= 1 itens <= 5000 itens itens únicos

object

object

ponto

obrigatório

array

>= 2 itens

raio_m

obrigatório

integer

>= 50 <= 50000

momento

obrigatório

Um de:

object

object

semana

obrigatório

integer

>= 1

object

object

parte

obrigatório

number

> 0 <= 1

ordem

Valores aceitos: maior menor

object

object

id

obrigatório

string

/^[a-z0-9][a-z0-9_-]{0,39}$/

forma

obrigatório

Valor aceito: comparar

variantes

obrigatório

Array<string>

>= 2 itens <= 2 itens itens únicos

pergunta

obrigatório

object

id

obrigatório

string

/^[a-z0-9][a-z0-9_-]{0,39}$/

forma

obrigatório

Valores aceitos: quantos quando onde

medida

obrigatório

Valores aceitos: adotantes alcance ignora absorve repassa rejeita adocao exposta_social exposta_midia_medida exposta_midia_declarada exposta_midia_ambas ignora absorve repassa rejeita

publico

object

grupo_idade

Array<integer>

itens únicos

sexo

Array<integer>

itens únicos

renda

Array<integer>

itens únicos

escolaridade

Array<integer>

itens únicos

raca

Array<integer>

itens únicos

faixa_etaria_5

Array<integer>

itens únicos

territorio

obrigatório

Um de:

object

object

municipios

obrigatório

Array<string>

>= 1 itens <= 5000 itens itens únicos

object

object

setores

obrigatório

Array<string>

>= 1 itens <= 5000 itens itens únicos

object

object

ponto

obrigatório

array

>= 2 itens

raio_m

obrigatório

integer

>= 50 <= 50000

momento

obrigatório

Um de:

object

object

semana

obrigatório

integer

>= 1

object

object

parte

obrigatório

number

> 0 <= 1

ordem

Valores aceitos: maior menor

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:

unknown

Valor aceito: celula

Array

Array

>= 1 itens itens únicos

Valores aceitos: regiao faixa sexo raca nivel renda

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>

Array<object>

<= 150000 itens

object

key

propriedades adicionais

any

null

null

serie_sha256

Qualquer um de:

string

string

null

null

Respostas

201

Resposta bem-sucedida

Tipo de mídiaapplication/json

object

id

obrigatório

string formato: uuid

project_id

obrigatório

string formato: uuid

nome

Qualquer um de:

string

string

null

null

estado

obrigatório

string

tipo

obrigatório

string

preco_micros

obrigatório

integer

criado_em

obrigatório

string formato: date-time

registro

obrigatório

object

key

propriedades adicionais

any

apagamento_pedido_em

Qualquer um de:

string

string formato: date-time

null

null

Exemplo ^gerado

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "nome": "example",
  "estado": "example",
  "tipo": "example",
  "preco_micros": 1,
  "criado_em": "2026-04-15T12:00:00Z",
  "registro": {},
  "apagamento_pedido_em": "2026-04-15T12:00:00Z"
}

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": {}
    }
  ]
}