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

# Pedir proposta ao assistente

> O assistente de configuração propõe um mapeamento, esquema, política ou regra como diff para aprovação.



## OpenAPI

````yaml openapi/pt/cell.json POST /v1/assist
openapi: 3.1.0
info:
  title: API de dados da Niadra
  version: '1'
  description: >-
    Escrita, contexto, histórico, objetos, identidade, privacidade e governança
    de um espaço. Cada espaço tem um endereço estável, com o espaço e a região
    no nome.
servers:
  - url: https://{space}.{region}.api.niadra.com
    variables:
      space:
        default: acme-prod
        description: O espaço, que vem na chave de fonte.
      region:
        default: us-east-1
        description: A região do espaço, que também vem na chave.
security: []
paths:
  /v1/assist:
    post:
      tags:
        - governance
      summary: Pedir proposta ao assistente
      description: >-
        Pede uma proposta ao assistente de configuração: um mapeamento de
        webhook, um esquema de extração, uma política de fonte ou uma regra de
        gatilho ou de padrão. Ele trabalha com amostras mascaradas dentro da
        célula e produz um diff versionado com as verificações; uma pessoa
        aprova na API de controle. O assistente nunca muda a configuração
        sozinho.


        **Autenticação.** Token de pessoa do Console com o papel `integration`
        (ou admin), ou chave de fonte com o escopo `admin`.
      operationId: request_assist_v1_assist_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssistRequest'
            example:
              task: webhook_mapping
              source_id: 0192f79e-11ab-7c31-8e4f-7d2e3f506b71
              description: 'Map the ERP invoice events: credited, disputed and overdue.'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssistRunOut'
              example:
                run_id: 0192f7c0-5d21-7f3b-8a4c-2b3c4d5e6f70
                task: webhook_mapping
                status: queued
                created_at: '2026-09-22T19:00:00Z'
                config_type: null
                diff_id: null
                diff_hash: null
                checks: {}
                problems: []
          description: Na fila. Acompanhe a execução até `proposed` ou `delivered`.
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: O pedido não bate com o contrato.
      security:
        - sourceKey: []
        - personToken: []
components:
  schemas:
    AssistRequest:
      additionalProperties: false
      properties:
        description:
          anyOf:
            - maxLength: 2000
              minLength: 3
              type: string
            - type: 'null'
          description: >-
            Para que serve o agente, ou a regra em palavras simples; mascarado
            antes de qualquer uso.
          title: Description
        source_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Source Id
        task:
          $ref: '#/components/schemas/AssistTask'
      required:
        - task
      title: AssistRequest
      type: object
    AssistRunOut:
      additionalProperties: false
      properties:
        checks:
          additionalProperties: true
          description: Validação contra as amostras, dentro da célula.
          title: Checks
          type: object
        config_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Config Type
        created_at:
          format: date-time
          title: Created At
          type: string
        diff_hash:
          anyOf:
            - type: string
            - type: 'null'
          title: Diff Hash
        diff_id:
          anyOf:
            - type: string
            - type: 'null'
          description: O diff que espera aprovação no plano de controle.
          title: Diff Id
        document:
          description: >-
            O documento de configuração proposto, como foi enviado ao plano de
            controle.
          title: Document
        problems:
          items:
            type: string
          title: Problems
          type: array
        run_id:
          format: uuid
          title: Run Id
          type: string
        status:
          $ref: '#/components/schemas/AssistStatus'
        task:
          $ref: '#/components/schemas/AssistTask'
      required:
        - run_id
        - task
        - status
        - created_at
      title: AssistRunOut
      type: object
    Problem:
      additionalProperties: false
      description: >-
        Detalhes do problema no formato da RFC 9457; `code` vem do catálogo de
        erros versionado.
      properties:
        code:
          title: Code
          type: string
        detail:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Detail
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Request Id
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          default: about:blank
          title: Type
          type: string
      required:
        - title
        - status
        - code
      title: Problem
      type: object
    AssistTask:
      enum:
        - webhook_mapping
        - extraction_schema
        - source_policy
        - trigger_or_trait_rule
      title: AssistTask
      type: string
    AssistStatus:
      enum:
        - queued
        - proposed
        - delivered
        - rejected
        - failed
      title: AssistStatus
      type: string
  securitySchemes:
    sourceKey:
      type: http
      scheme: bearer
      description: nia_sk_...
    personToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````