> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nlbs.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar uma versão do catálogo de regras

> Retorna o manifesto e o catálogo de uma versão específica das regras.



## OpenAPI

````yaml GET /rules/versions/{version}
openapi: 3.1.0
info:
  description: Superfície pública da API para clientes autenticados por chave de API.
  title: NL Labs Gateway (Public API)
  version: 0.1.0
servers:
  - url: https://api.nlbs.ai
security: []
tags:
  - description: Busca de entidades canônicas.
    name: entities
  - description: Criação, leitura, grafo e dossiê de análises.
    name: analyses
  - description: Relatório regulatório (COAF/SUSEP).
    name: reports
  - description: Triagem de mídia adversa.
    name: adverse-media
  - description: Versões do manifesto regulatório.
    name: regulatory
  - description: Versões do catálogo de regras do motor de risco.
    name: rules
  - description: Endpoints e eventos de webhook.
    name: webhooks
  - description: >-
      Entrypoints HTTP de workflow: invocar um workflow e consultar sua
      execução.
    name: workflow-endpoints
paths:
  /rules/versions/{version}:
    get:
      tags:
        - rules
      summary: Consultar uma versão do catálogo de regras
      description: Retorna o manifesto e o catálogo de uma versão específica das regras.
      operationId: get_rules_version
      parameters:
        - description: Rótulo da versão do catálogo de regras.
          in: path
          name: version
          required: true
          schema:
            description: Rótulo da versão do catálogo de regras.
            examples:
              - 0.1.0
            title: Version
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RulesVersionSnapshotResponse'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Chave de API ausente, malformada, expirada ou inválida.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: A chave de API autenticada não tem o escopo necessário.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Versão do catálogo de regras não encontrada.
        '422':
          description: >-
            Corpo da requisição, parâmetro de rota, parâmetro de query ou regra
            de negócio inválidos.
components:
  schemas:
    RulesVersionSnapshotResponse:
      properties:
        catalog:
          description: >-
            Entradas públicas do catálogo de regras (nome/descrição apenas; sem
            fórmulas).
          items:
            $ref: '#/components/schemas/RulesCatalogEntryResponse'
          title: Catalog
          type: array
        manifest:
          $ref: '#/components/schemas/RulesManifestResponse'
          description: Metadados do manifesto do snapshot.
      required:
        - manifest
        - catalog
      title: RulesVersionSnapshotResponse
      type: object
    ErrorResponse:
      properties:
        detail:
          description: Mensagem de erro pública e estável.
          examples:
            - Resource not found.
          title: Detail
          type: string
      required:
        - detail
      title: ErrorResponse
      type: object
    RulesCatalogEntryResponse:
      additionalProperties: false
      examples:
        - code: R-J-022-S
          description: >-
            Entidade da rede societária da contraparte ré em processo penal
            ativo por fraude.
          kind: observable
          name: Ré em fraude na rede societária
          pillar: jud
          severity: high
          version: 1.0.0
      properties:
        code:
          description: Código estável do sinal.
          examples:
            - R-J-022-S
          title: Code
          type: string
        description:
          description: Descrição do sinal, voltada ao cliente.
          examples:
            - >-
              Entidade da rede societária da contraparte ré em processo penal
              ativo por fraude.
          title: Description
          type: string
        kind:
          $ref: '#/components/schemas/SignalKind'
          description: Tipo do sinal.
          examples:
            - observable
        name:
          description: Nome do sinal, voltado ao cliente.
          examples:
            - Ré em fraude na rede societária
          title: Name
          type: string
        pillar:
          anyOf:
            - $ref: '#/components/schemas/PillarCode'
            - type: 'null'
          description: Pilar analítico, quando o sinal é observável.
          examples:
            - jud
        severity:
          $ref: '#/components/schemas/SignalSeverity'
          description: Rótulo de severidade do sinal.
          examples:
            - high
        version:
          description: Versão publicada da definição do sinal.
          examples:
            - 1.0.0
          title: Version
          type: string
      required:
        - code
        - name
        - description
        - kind
        - severity
        - version
      title: RulesCatalogEntryResponse
      type: object
    RulesManifestResponse:
      examples:
        - catalog_hash: sha256:example
          published_at: '2026-06-23T00:00:00Z'
          signal_count: 42
          version: 0.1.0
      properties:
        catalog_hash:
          description: Hash determinístico do payload do catálogo de regras.
          examples:
            - sha256:example
          title: Catalog Hash
          type: string
        published_at:
          description: Timestamp de publicação deste snapshot congelado de regras.
          examples:
            - '2026-06-23T00:00:00Z'
          format: date-time
          title: Published At
          type: string
        signal_count:
          description: Número de sinais no catálogo.
          examples:
            - 42
          title: Signal Count
          type: integer
        version:
          description: Versão semântica do catálogo de regras.
          examples:
            - 0.1.0
          title: Version
          type: string
      required:
        - version
        - published_at
        - catalog_hash
        - signal_count
      title: RulesManifestResponse
      type: object
    SignalKind:
      enum:
        - observable
        - meta
      title: SignalKind
      type: string
    PillarCode:
      enum:
        - sanc
        - estru
        - jud
        - pep
        - juris
      title: PillarCode
      type: string
    SignalSeverity:
      enum:
        - clean
        - enrichment
        - low
        - medium
        - medium_high
        - high
        - very_high
        - critical
      title: SignalSeverity
      type: string

````