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

# AI-propose every mapping document a pipeline default needs from one pasted sample; with config_values, re-check those documents with the reader's pins instead (no model call).



## OpenAPI

````yaml POST /v1/furnishing/mapping/propose
openapi: 3.1.0
info:
  title: SOLO Network API
  version: v1
servers:
  - url: https://api.solo.one
    description: Production
  - url: https://api.sandbox.solo.one
    description: Sandbox
security: []
paths:
  /v1/furnishing/mapping/propose:
    post:
      tags:
        - Furnishing — Mapping Dry-Run
      summary: >-
        AI-propose every mapping document a pipeline default needs from one
        pasted sample; with config_values, re-check those documents with the
        reader's pins instead (no model call).
      operationId: mapping_propose_v1_furnishing_mapping_propose_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MappingProposeRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingProposeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    MappingProposeRequest:
      properties:
        source_default_slug:
          type: string
          title: Source Default Slug
          description: >-
            Mapping-default pipeline to propose for, e.g. jsonl_mapping_default
            or jsonl_mapping_business_default.
        row_schema:
          additionalProperties: true
          type: object
          title: Row Schema
          description: Client-dialect schema inferred from the pasted records.
        sample:
          additionalProperties: true
          type: object
          title: Sample
          description: One pasted record; evaluated on the server for the preview.
        share_sample_with_model:
          type: boolean
          title: Share Sample With Model
          description: Send the sample's values to the model as well as its structure.
          default: false
        pins:
          additionalProperties:
            additionalProperties:
              additionalProperties:
                $ref: '#/components/schemas/MappingSuggestPin'
              type: object
            type: object
          type: object
          title: Pins
          description: >-
            step -> alias -> target pointer -> the reader's own binding, which
            wins over the model.
        config_values:
          anyOf:
            - additionalProperties:
                additionalProperties:
                  additionalProperties: true
                  type: object
                type: object
              type: object
            - type: 'null'
          title: Config Values
          description: >-
            step -> alias -> mapping/1 document from an earlier proposal;
            re-checked with pins, no model call.
      type: object
      required:
        - source_default_slug
        - row_schema
        - sample
      title: MappingProposeRequest
    MappingProposeResponse:
      properties:
        config_values:
          additionalProperties:
            additionalProperties:
              additionalProperties: true
              type: object
            type: object
          type: object
          title: Config Values
          description: step -> alias -> mapping/1 document, ready for furnish.viaSample.
        entries:
          items:
            $ref: '#/components/schemas/MappingProposeEntry'
          type: array
          title: Entries
          description: >-
            Each mapping step's target, roots, pins and target models, so the
            proposal can be drawn on the graph.
        rows:
          items:
            $ref: '#/components/schemas/MappingProposeRow'
          type: array
          title: Rows
        blocking_missing:
          items:
            $ref: '#/components/schemas/MappingProposeMissing'
          type: array
          title: Blocking Missing
          description: >-
            Required target fields nothing binds; the mapping cannot be saved
            until each is bound.
        optional_missing:
          items:
            $ref: '#/components/schemas/MappingProposeMissing'
          type: array
          title: Optional Missing
          description: >-
            Fields the model noted it could not bind that the target does not
            require.
        verified:
          type: boolean
          title: Verified
          description: >-
            Every step produced a document free of problems besides missing
            fields.
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
          description: What went wrong, when verified is false.
      type: object
      required:
        - config_values
        - rows
        - blocking_missing
        - optional_missing
        - verified
      title: MappingProposeResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MappingSuggestPin:
      properties:
        kind:
          type: string
          enum:
            - const
            - root
          title: Kind
        value:
          anyOf:
            - {}
            - type: 'null'
          title: Value
          description: Constant value (const pins).
        root:
          anyOf:
            - type: string
            - type: 'null'
          title: Root
          description: Root alias the pin reads (root pins).
        pointer:
          type: string
          title: Pointer
          description: JSON Pointer into the root; empty = whole-root read.
          default: ''
      type: object
      required:
        - kind
      title: MappingSuggestPin
    MappingProposeEntry:
      properties:
        step:
          type: string
          title: Step
        alias:
          type: string
          title: Alias
        target:
          additionalProperties: true
          type: object
          title: Target
          description: The entry's target schema, as the mapping writes it.
        roots:
          additionalProperties: true
          type: object
          title: Roots
          description: alias -> source schema, with row set to the pasted records.
        pins:
          additionalProperties: true
          type: object
          title: Pins
          description: 'Stored pins: target pointer -> {value} or {from, path}.'
        target_models:
          additionalProperties:
            type: string
          type: object
          title: Target Models
          description: >-
            UI object path in the target -> the model it persists as, for
            placing fields on the graph.
      type: object
      required:
        - step
        - alias
        - target
        - roots
        - pins
        - target_models
      title: MappingProposeEntry
    MappingProposeRow:
      properties:
        step:
          type: string
          title: Step
        alias:
          type: string
          title: Alias
        target_path:
          type: string
          title: Target Path
          description: UI target path bound, e.g. /first_name or /data/addresses/[]/city.
        source_pointer:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Pointer
          description: Source field it reads, e.g. /given_name; null when computed.
        preview:
          anyOf:
            - {}
            - type: 'null'
          title: Preview
          description: Its value over the sample (first element of lists).
        rationale:
          anyOf:
            - type: string
            - type: 'null'
          title: Rationale
          description: The model's one-line reason, for suggested bindings.
      type: object
      required:
        - step
        - alias
        - target_path
        - source_pointer
      title: MappingProposeRow
    MappingProposeMissing:
      properties:
        step:
          type: string
          title: Step
        alias:
          type: string
          title: Alias
        target_path:
          type: string
          title: Target Path
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
          description: Why the model left it unbound, when it said.
      type: object
      required:
        - step
        - alias
        - target_path
      title: MappingProposeMissing
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.