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

# Preview or insert new source rows only

> Insert-only, regardless of the adapter's default behavior. Uses the adapter's configured business ID fields or adapter-provided row IDs, within each destination. Existing IDs fail with ROW_ALREADY_EXISTS and direct clients to POST /source-imports/amendments. Repeated IDs within the batch fail with DUPLICATE_ROW_ID. Does not accept onExistingRow. Requires Idempotency-Key (1–200 printable ASCII characters, no spaces); identical retries reuse the run, changed contents return 409. Defaults to preview. Maximum 10,000 rows and 10 MiB. Execution is synchronous and may partially succeed: inspect outcomes.planned/actual and per-row results, including errorCode and message, even on HTTP 200. Form-value inserts add source contributions and recalculate the shared total without replacing existing contributions.



## OpenAPI

````yaml /openapi/en.json post /source-imports
openapi: 3.0.3
info:
  title: Erguvan Public API
  version: 1.0.0
servers:
  - url: https://app.azalt.co/api/v1
security: []
paths:
  /source-imports:
    post:
      tags:
        - Source imports
      summary: Preview or insert new source rows only
      description: >-
        Insert-only, regardless of the adapter's default behavior. Uses the
        adapter's configured business ID fields or adapter-provided row IDs,
        within each destination. Existing IDs fail with ROW_ALREADY_EXISTS and
        direct clients to POST /source-imports/amendments. Repeated IDs within
        the batch fail with DUPLICATE_ROW_ID. Does not accept onExistingRow.
        Requires Idempotency-Key (1–200 printable ASCII characters, no spaces);
        identical retries reuse the run, changed contents return 409. Defaults
        to preview. Maximum 10,000 rows and 10 MiB. Execution is synchronous and
        may partially succeed: inspect outcomes.planned/actual and per-row
        results, including errorCode and message, even on HTTP 200. Form-value
        inserts add source contributions and recalculate the shared total
        without replacing existing contributions.
      operationId: submitSourceImport
      parameters:
        - in: header
          name: Idempotency-Key
          description: Unique per submission and API-key owner. Reuse unchanged on retries.
          schema:
            type: string
            minLength: 1
            maxLength: 200
            description: >-
              Unique per submission and API-key owner. Reuse unchanged on
              retries.
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                sourceAdapterDefinitionId:
                  type: string
                  minLength: 1
                  maxLength: 200
                adapterVersion:
                  type: string
                  pattern: ^[a-f0-9]{64}$
                mode:
                  type: string
                  enum:
                    - preview
                    - execute
                  default: preview
                allowMissingFormSiteCreation:
                  type: boolean
                  default: false
                context:
                  type: object
                  properties:
                    year:
                      type: integer
                      minimum: 1900
                      maximum: 2200
                    siteId:
                      type: string
                      minLength: 1
                      maxLength: 200
                  additionalProperties: false
                sheets:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        minLength: 1
                        maxLength: 200
                      rows:
                        type: array
                        items:
                          type: object
                          additionalProperties:
                            anyOf:
                              - type: string
                                nullable: true
                                maxLength: 16000
                              - type: number
                              - type: boolean
                        maxItems: 10000
                    required:
                      - name
                      - rows
                    additionalProperties: false
                  minItems: 1
                  maxItems: 50
              required:
                - sourceAdapterDefinitionId
                - adapterVersion
                - sheets
              additionalProperties: false
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  outcomes:
                    type: object
                    properties:
                      planned:
                        type: object
                        properties:
                          inserted:
                            type: integer
                            minimum: 0
                          updated:
                            type: integer
                            minimum: 0
                          replaced:
                            type: integer
                            minimum: 0
                          deleted:
                            type: integer
                            minimum: 0
                          skipped:
                            type: integer
                            minimum: 0
                          failed:
                            type: integer
                            minimum: 0
                          unknown:
                            type: integer
                            minimum: 0
                        required:
                          - inserted
                          - updated
                          - replaced
                          - deleted
                          - skipped
                          - failed
                          - unknown
                      actual:
                        type: object
                        properties:
                          inserted:
                            type: integer
                            minimum: 0
                          updated:
                            type: integer
                            minimum: 0
                          replaced:
                            type: integer
                            minimum: 0
                          deleted:
                            type: integer
                            minimum: 0
                          skipped:
                            type: integer
                            minimum: 0
                          failed:
                            type: integer
                            minimum: 0
                          unknown:
                            type: integer
                            minimum: 0
                        required:
                          - inserted
                          - updated
                          - replaced
                          - deleted
                          - skipped
                          - failed
                          - unknown
                    required:
                      - planned
                      - actual
                  run:
                    type: object
                    properties:
                      id:
                        type: string
                      sourceAdapterDefinitionId:
                        type: string
                      organizationId:
                        type: string
                      userId:
                        type: string
                      mediaId:
                        type: string
                        nullable: true
                      fileName:
                        type: string
                        nullable: true
                      status:
                        type: string
                        enum:
                          - pending
                          - previewed
                          - processing
                          - completed
                          - failed
                      totalRows:
                        type: integer
                      draftCount:
                        type: integer
                      issueCount:
                        type: integer
                      activityWriteCount:
                        type: integer
                      formValueWriteCount:
                        type: integer
                      error:
                        type: string
                        nullable: true
                      processedAt:
                        type: string
                        nullable: true
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                      deletedAt:
                        type: string
                        nullable: true
                    required:
                      - id
                      - sourceAdapterDefinitionId
                      - organizationId
                      - userId
                      - mediaId
                      - fileName
                      - status
                      - totalRows
                      - draftCount
                      - issueCount
                      - activityWriteCount
                      - formValueWriteCount
                      - error
                      - processedAt
                      - createdAt
                      - updatedAt
                      - deletedAt
                  adapterVersion:
                    type: string
                  counts:
                    type: object
                    properties:
                      total:
                        type: integer
                        minimum: 0
                      parsed:
                        type: integer
                        minimum: 0
                      ready:
                        type: integer
                        minimum: 0
                      imported:
                        type: integer
                        minimum: 0
                      reduced:
                        type: integer
                        minimum: 0
                      skipped:
                        type: integer
                        minimum: 0
                      failed:
                        type: integer
                        minimum: 0
                    required:
                      - total
                      - parsed
                      - ready
                      - imported
                      - reduced
                      - skipped
                      - failed
                  replayed:
                    type: boolean
                  execution:
                    type: object
                    properties:
                      attempted:
                        type: boolean
                      blocked:
                        type: boolean
                      message:
                        type: string
                        nullable: true
                      readiness:
                        type: object
                        nullable: true
                        properties:
                          requiresMissingFormSiteConfirmation:
                            type: boolean
                          missingFormSites:
                            type: array
                            items:
                              type: object
                              properties:
                                formId:
                                  type: string
                                formName:
                                  type: string
                                siteId:
                                  type: string
                                siteName:
                                  type: string
                                  nullable: true
                                year:
                                  type: integer
                                rowCount:
                                  type: integer
                                  minimum: 0
                                  exclusiveMinimum: true
                                draftKinds:
                                  type: array
                                  items:
                                    type: string
                                    enum:
                                      - activity
                                      - form_value
                                targetKeys:
                                  type: array
                                  items:
                                    type: string
                                rowIndexes:
                                  type: array
                                  items:
                                    type: integer
                                    minimum: 0
                              required:
                                - formId
                                - formName
                                - siteId
                                - siteName
                                - year
                                - rowCount
                                - draftKinds
                                - targetKeys
                                - rowIndexes
                        required:
                          - requiresMissingFormSiteConfirmation
                          - missingFormSites
                    required:
                      - attempted
                      - blocked
                      - message
                      - readiness
                required:
                  - outcomes
                  - run
                  - adapterVersion
                  - counts
                  - replayed
                  - execution
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
      security:
        - Authorization: []
components:
  schemas:
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.UNAUTHORIZED:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Authorization not provided
        code:
          type: string
          description: The error code
          example: UNAUTHORIZED
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Authorization not provided error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
    error.FORBIDDEN:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Insufficient access
        code:
          type: string
          description: The error code
          example: FORBIDDEN
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Insufficient access error (403)
      description: The error information
      example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Internal server error
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Internal server error error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````