GET /api/v1/playbooks

Retorna a lista de playbooks disponíveis: as combinações de conduct_type e language que o endpoint de análise aceita como valores válidos.

Autenticação

Requer API key com o escopo playbooks:list.

Authorization: Bearer vario_SUA_API_KEY

Parâmetros

Este endpoint não aceita corpo nem query parameters.

Resposta

HTTP 200 — sucesso

{
  "playbooks": [PlaybookEntry]
}

Estrutura da resposta

Campo	Tipo	Descrição
`playbooks`	`array`	Lista de objetos `PlaybookEntry`. Pode crescer em versões futuras.

PlaybookEntry

Campo	Tipo	Descrição
`conduct_type`	`string`	Identificador da conduta. Usar este valor no campo `playbook` de `POST /analyze`.
`languages`	`array[string]`	Códigos ISO 639-1 dos idiomas suportados para este playbook.
`description`	`string`	Descrição breve da conduta.
`version`	`string`	Versão do playbook.

Condutas disponíveis

`conduct_type`	Conduta	Idiomas
`price_fixing`	Fixação de preços	`es`, `en`
`bid_rigging`	Fraude em licitações	`es`, `en`
`bribery`	Suborno e anticorrupção	`es`, `en`
`market_manipulation`	Abuso de mercado	`es`, `en`
`information_exchange`	Troca de informações comercialmente sensíveis	`es`, `en`
`group_boycott`	Boicote coletivo	`es`, `en`
`conflict_of_interest`	Conflitos de interesse não declarados e autocontratação	`es`, `en`
`insider_trading`	Uso de informação privilegiada e tipping	`es`, `en`
`internal_fraud`	Fraude interna, desvio de recursos e fraude de despesas	`es`, `en`

Quando chamar este endpoint

Ao inicializar a integração: obtenha os valores válidos de conduct_type antes de construir qualquer requisição a POST /analyze. Enviar um playbook não reconhecido retorna 400 INVALID_PLAYBOOK.
Para detectar novos playbooks: o vario incorporará novas condutas em versões futuras. Chame este endpoint de forma dinâmica em vez de fixar os valores no código, para que sua integração os suporte automaticamente.

Exemplo completo

Requisição:

curl https://api.vario.lat/v1/playbooks \
  -H "Authorization: Bearer vario_SUA_API_KEY"

Resposta:

{
  "playbooks": [
    {
      "conduct_type": "price_fixing",
      "languages": ["es", "en"],
      "description": "Fixação de preços entre concorrentes",
      "version": "1.0"
    },
    {
      "conduct_type": "bid_rigging",
      "languages": ["es", "en"],
      "description": "Fraude em licitações e processos de compra",
      "version": "1.0"
    },
    {
      "conduct_type": "bribery",
      "languages": ["es", "en"],
      "description": "Suborno e violações anticorrupção",
      "version": "1.0"
    },
    {
      "conduct_type": "market_manipulation",
      "languages": ["es", "en"],
      "description": "Abuso de mercado",
      "version": "1.0"
    },
    {
      "conduct_type": "information_exchange",
      "languages": ["es", "en"],
      "description": "Troca de informações comercialmente sensíveis entre concorrentes",
      "version": "1.0"
    },
    {
      "conduct_type": "group_boycott",
      "languages": ["es", "en"],
      "description": "Boicote coletivo e práticas de exclusão concertada",
      "version": "1.0"
    },
    {
      "conduct_type": "conflict_of_interest",
      "languages": ["es", "en"],
      "description": "Conflitos de interesse não declarados e autocontratação",
      "version": "1.0.0"
    },
    {
      "conduct_type": "insider_trading",
      "languages": ["es", "en"],
      "description": "Uso de informação privilegiada e tipping",
      "version": "1.0.0"
    },
    {
      "conduct_type": "internal_fraud",
      "languages": ["es", "en"],
      "description": "Fraude interna, desvio de recursos e fraude de despesas",
      "version": "1.0.0"
    }
  ]
}

Erros possíveis

HTTP	Código	Descrição
`401`	`MISSING_AUTH`	Header `Authorization` ausente.
`401`	`INVALID_API_KEY`	API key não encontrada, expirada ou inativa.
`402`	`SUBSCRIPTION_REQUIRED`	O tenant não possui assinatura ativa.
`403`	`INSUFFICIENT_SCOPE`	A API key não tem o escopo `playbooks:list`.
`429`	`RATE_LIMIT_EXCEEDED`	Rate limit atingido. Consulte o header `Retry-After`.

Nota sobre versões futuras

O vario adicionará novos playbooks e novos idiomas em versões futuras. Recomenda-se chamar GET /playbooks de forma dinâmica ao iniciar cada sessão de integração em vez de fixar a lista de condutas no código. Os valores de conduct_type são estáveis uma vez publicados — não são renomeados entre versões menores.