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

# Validate an import mapping

> Validate a finalized source->target mapping before any import. Flags a missing root-identity mapping, source/target type mismatches, vector-dim mismatches against a known index, and unknown source fields.



## OpenAPI

````yaml post /v1/collections/import/validate-mapping
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security:
  - BearerAuth: []
paths:
  /v1/collections/import/validate-mapping:
    post:
      tags:
        - Collections
      summary: Validate an import mapping
      description: >-
        Validate a finalized source->target mapping before any import. Flags a
        missing root-identity mapping, source/target type mismatches, vector-dim
        mismatches against a known index, and unknown source fields.
      operationId: validate_import_mapping_v1_collections_import_validate_mapping_post
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MappingValidationRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingValidationResult'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
          NamespaceHeader: []
components:
  schemas:
    MappingValidationRequest:
      properties:
        source_fields:
          items:
            $ref: '#/components/schemas/SourceField'
          type: array
          title: Source Fields
          description: The declared source fields.
        mapping:
          $ref: '#/components/schemas/ImportMapping'
          description: The finalized source->target mapping to validate.
        known_index_dims:
          anyOf:
            - additionalProperties:
                type: integer
              type: object
            - type: 'null'
          title: Known Index Dims
          description: Known target vector index dims, for dim-mismatch checks.
      type: object
      required:
        - mapping
      title: MappingValidationRequest
      description: Request body for POST /v1/collections/import/validate-mapping.
    MappingValidationResult:
      properties:
        ok:
          type: boolean
          title: Ok
        errors:
          items:
            $ref: '#/components/schemas/MappingValidationError'
          type: array
          title: Errors
      type: object
      required:
        - ok
      title: MappingValidationResult
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SourceField:
      properties:
        path:
          type: string
          title: Path
        type:
          type: string
          enum:
            - string
            - integer
            - float
            - boolean
            - datetime
            - vector
            - object
            - 'null'
          title: Type
      type: object
      required:
        - path
        - type
      title: SourceField
      description: A declared source field (validate-mapping input).
    ImportMapping:
      properties:
        fields:
          items:
            $ref: '#/components/schemas/FieldMapping'
          type: array
          title: Fields
        source_type:
          anyOf:
            - type: string
              enum:
                - bucket
                - collection
            - type: 'null'
          title: Source Type
        chain_template:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Chain Template
      additionalProperties: true
      type: object
      title: ImportMapping
      description: The finalized mapping. This IS the import config.
    MappingValidationError:
      properties:
        field:
          anyOf:
            - type: string
            - type: 'null'
          title: Field
          description: Source field the error is about; None for whole-mapping errors.
        error:
          type: string
          title: Error
      type: object
      required:
        - error
      title: MappingValidationError
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    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
    FieldMapping:
      properties:
        source_field:
          type: string
          title: Source Field
        target:
          $ref: '#/components/schemas/MappingTarget'
      type: object
      required:
        - source_field
        - target
      title: FieldMapping
    MappingTarget:
      properties:
        kind:
          type: string
          enum:
            - metadata
            - vector
            - identity
            - parent
            - ignore
          title: Kind
          description: metadata | vector | identity | parent | ignore
        path:
          anyOf:
            - type: string
            - type: 'null'
          title: Path
          description: Target path for kind=metadata (e.g. 'metadata.brand').
        index:
          anyOf:
            - type: string
            - type: 'null'
          title: Index
          description: Vector index name for kind=vector.
        dim:
          anyOf:
            - type: integer
            - type: 'null'
          title: Dim
          description: Vector dimension for kind=vector.
        dtype:
          anyOf:
            - type: string
            - type: 'null'
          title: Dtype
          description: Source vector dtype for kind=vector (e.g. 'float16-base64').
        role:
          anyOf:
            - type: string
              enum:
                - root_object_id
                - root_bucket_id
                - source_object_id
                - source_document_id
                - source_collection_id
                - document_id
                - content_hash
            - type: 'null'
          title: Role
          description: Lineage role for kind=identity.
        chain_position:
          anyOf:
            - type: integer
            - type: 'null'
          title: Chain Position
          description: Position in chain[] for kind=parent.
        expected_type:
          anyOf:
            - type: string
              enum:
                - string
                - integer
                - float
                - boolean
                - datetime
                - vector
                - object
                - 'null'
            - type: 'null'
          title: Expected Type
          description: >-
            The source type this target requires. When set and the inferred
            source type differs, validate_mapping flags it (unhappy case f).
      additionalProperties: true
      type: object
      required:
        - kind
      title: MappingTarget
      description: Where a source field lands in the Mixpeek document.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Mixpeek API key, sent as `Authorization: Bearer mxp_sk_...`. Create one
        in Studio under Settings → API Keys, or with an admin key via `POST
        /v1/organizations/users/{user_email}/api-keys`. A missing header returns
        403; an invalid or revoked key returns 401.
    NamespaceHeader:
      type: apiKey
      in: header
      name: X-Namespace
      description: >-
        Namespace id (`ns_...`), not the namespace name. This scopes the request
        rather than authenticating it, and it is required on every operation
        marked `x-mixpeek-namespace-scoped`.

````