API Reference — subpackage_data-clips

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_data-clips
  description: 'API Reference — subpackage_data-clips. 10 operations. Lead operation: Create. Self-contained Naftiko capability
    covering one Flatfile business surface.'
  tags:
  - Flatfile
  - subpackage_data-clips
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FLATFILE_API_KEY: FLATFILE_API_KEY
capability:
  consumes:
  - type: http
    namespace: flatfile-subpackage-data-clips
    baseUri: https://api.x.flatfile.com/v1
    description: API Reference — subpackage_data-clips business capability. Self-contained, no shared references.
    resources:
    - name: data-clips
      path: /data-clips
      operations:
      - name: create
        method: POST
        description: Create
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: list
        method: GET
        description: List
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: spaceId
          in: query
          type: string
        - name: sheetId
          in: query
          type: string
        - name: status
          in: query
          type: string
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    - name: data-clips-dataClipId
      path: /data-clips/{dataClipId}
      operations:
      - name: update
        method: PATCH
        description: Update
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataClipId
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: Delete
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataClipId
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
      - name: get
        method: GET
        description: Get
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataClipId
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    - name: data-clips-dataClipId-add-records
      path: /data-clips/{dataClipId}/add-records
      operations:
      - name: addrecordstoclip
        method: POST
        description: Add Records To Clip
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataClipId
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: data-clips-dataClipId-refresh-resolutions
      path: /data-clips/{dataClipId}/refresh-resolutions
      operations:
      - name: refreshresolutions
        method: PATCH
        description: Refresh Resolutions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataClipId
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    - name: data-clips-dataClipId-resolutions
      path: /data-clips/{dataClipId}/resolutions
      operations:
      - name: getresolutions
        method: GET
        description: Get Resolutions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataClipId
          in: path
          type: string
          required: true
        - name: includeRecords
          in: query
          type: boolean
          description: Include records in the response. Default is true
        - name: includeSummary
          in: query
          type: boolean
          description: Include summary in the response. Default is false
        - name: filterColumn
          in: query
          type: string
          description: The column to filter by.
        - name: filterConflicts
          in: query
          type: boolean
          description: Whether to filter only conflicts. Default is false
        - name: pageSize
          in: query
          type: integer
          description: Number of resolutions to return in a page. Default is 1000
        - name: pageNumber
          in: query
          type: integer
          description: Page number of resolutions to return
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
      - name: updateresolution
        method: PATCH
        description: Update Resolution
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataClipId
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: data-clips-dataClipId-resolutions-index
      path: /data-clips/{dataClipId}/resolutions/index
      operations:
      - name: getresolutionindex
        method: GET
        description: Get Resolution Index
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataClipId
          in: path
          type: string
          required: true
        - name: filterColumn
          in: query
          type: string
          description: The column to filter by.
        - name: filterConflicts
          in: query
          type: string
          description: Whether to filter only conflicts. Default is false
          required: true
        - name: id
          in: query
          type: string
          description: The record ID to get the index of.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.FLATFILE_API_KEY}}'
  exposes:
  - type: rest
    namespace: flatfile-subpackage-data-clips-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_data-clips. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/data-clips
      name: data-clips
      description: REST surface for data-clips.
      operations:
      - method: POST
        name: create
        description: Create
        call: flatfile-subpackage-data-clips.create
        with:
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: list
        description: List
        call: flatfile-subpackage-data-clips.list
        with:
          spaceId: rest.spaceId
          sheetId: rest.sheetId
          status: rest.status
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data-clips/{dataclipid}
      name: data-clips-dataclipid
      description: REST surface for data-clips-dataClipId.
      operations:
      - method: PATCH
        name: update
        description: Update
        call: flatfile-subpackage-data-clips.update
        with:
          dataClipId: rest.dataClipId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete
        call: flatfile-subpackage-data-clips.delete
        with:
          dataClipId: rest.dataClipId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: get
        description: Get
        call: flatfile-subpackage-data-clips.get
        with:
          dataClipId: rest.dataClipId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data-clips/{dataclipid}/add-records
      name: data-clips-dataclipid-add-records
      description: REST surface for data-clips-dataClipId-add-records.
      operations:
      - method: POST
        name: addrecordstoclip
        description: Add Records To Clip
        call: flatfile-subpackage-data-clips.addrecordstoclip
        with:
          dataClipId: rest.dataClipId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data-clips/{dataclipid}/refresh-resolutions
      name: data-clips-dataclipid-refresh-resolutions
      description: REST surface for data-clips-dataClipId-refresh-resolutions.
      operations:
      - method: PATCH
        name: refreshresolutions
        description: Refresh Resolutions
        call: flatfile-subpackage-data-clips.refreshresolutions
        with:
          dataClipId: rest.dataClipId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data-clips/{dataclipid}/resolutions
      name: data-clips-dataclipid-resolutions
      description: REST surface for data-clips-dataClipId-resolutions.
      operations:
      - method: GET
        name: getresolutions
        description: Get Resolutions
        call: flatfile-subpackage-data-clips.getresolutions
        with:
          dataClipId: rest.dataClipId
          includeRecords: rest.includeRecords
          includeSummary: rest.includeSummary
          filterColumn: rest.filterColumn
          filterConflicts: rest.filterConflicts
          pageSize: rest.pageSize
          pageNumber: rest.pageNumber
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateresolution
        description: Update Resolution
        call: flatfile-subpackage-data-clips.updateresolution
        with:
          dataClipId: rest.dataClipId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/data-clips/{dataclipid}/resolutions/index
      name: data-clips-dataclipid-resolutions-index
      description: REST surface for data-clips-dataClipId-resolutions-index.
      operations:
      - method: GET
        name: getresolutionindex
        description: Get Resolution Index
        call: flatfile-subpackage-data-clips.getresolutionindex
        with:
          dataClipId: rest.dataClipId
          filterColumn: rest.filterColumn
          filterConflicts: rest.filterConflicts
          id: rest.id
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: flatfile-subpackage-data-clips-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_data-clips. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create
      description: Create
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: flatfile-subpackage-data-clips.create
      with:
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list
      description: List
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-data-clips.list
      with:
        spaceId: tools.spaceId
        sheetId: tools.sheetId
        status: tools.status
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: update
      description: Update
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: flatfile-subpackage-data-clips.update
      with:
        dataClipId: tools.dataClipId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete
      description: Delete
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: flatfile-subpackage-data-clips.delete
      with:
        dataClipId: tools.dataClipId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: get
      description: Get
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-data-clips.get
      with:
        dataClipId: tools.dataClipId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: add-records-clip
      description: Add Records To Clip
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: flatfile-subpackage-data-clips.addrecordstoclip
      with:
        dataClipId: tools.dataClipId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: refresh-resolutions
      description: Refresh Resolutions
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: flatfile-subpackage-data-clips.refreshresolutions
      with:
        dataClipId: tools.dataClipId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: get-resolutions
      description: Get Resolutions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-data-clips.getresolutions
      with:
        dataClipId: tools.dataClipId
        includeRecords: tools.includeRecords
        includeSummary: tools.includeSummary
        filterColumn: tools.filterColumn
        filterConflicts: tools.filterConflicts
        pageSize: tools.pageSize
        pageNumber: tools.pageNumber
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: update-resolution
      description: Update Resolution
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: flatfile-subpackage-data-clips.updateresolution
      with:
        dataClipId: tools.dataClipId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-resolution-index
      description: Get Resolution Index
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-data-clips.getresolutionindex
      with:
        dataClipId: tools.dataClipId
        filterColumn: tools.filterColumn
        filterConflicts: tools.filterConflicts
        id: tools.id
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.