API Reference — subpackage_models

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_models
  description: 'API Reference — subpackage_models. 9 operations. Lead operation: Get Enrichment Source. Self-contained Naftiko
    capability covering one Polytomic business surface.'
  tags:
  - Polytomic
  - subpackage_models
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    POLYTOMIC_API_KEY: POLYTOMIC_API_KEY
capability:
  consumes:
  - type: http
    namespace: polytomic-subpackage-models
    baseUri: https://app.polytomic.com
    description: API Reference — subpackage_models business capability. Self-contained, no shared references.
    resources:
    - name: api-connections-id-modelsync-enrichment-source
      path: /api/connections/{id}/modelsync/enrichment-source
      operations:
      - name: getenrichmentsource
        method: GET
        description: Get Enrichment Source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier of the connection.
          required: true
        - name: params
          in: query
          type: object
          description: Query parameters used to incrementally refine a dependent source configuration. Keys correspond to
            configuration fields returned by previous calls to this endpo
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-enrichment-connection_id-inputfields
      path: /api/enrichment/{connection_id}/inputfields
      operations:
      - name: post
        method: POST
        description: Enrichment Fields
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connection_id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-model-preview
      path: /api/model-preview
      operations:
      - name: preview
        method: POST
        description: Preview Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: async
          in: query
          type: boolean
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-models
      path: /api/models
      operations:
      - name: list
        method: GET
        description: List Models
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
      - name: create
        method: POST
        description: Create Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: async
          in: query
          type: boolean
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-models-id
      path: /api/models/{id}
      operations:
      - name: get
        method: GET
        description: Get Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: async
          in: query
          type: boolean
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
      - name: update
        method: PUT
        description: Update Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: async
          in: query
          type: boolean
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: Delete Model
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: async
          in: query
          type: boolean
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-models-id-sample
      path: /api/models/{id}/sample
      operations:
      - name: sample
        method: GET
        description: Sample Records
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: async
          in: query
          type: boolean
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    authentication:
      type: bearer
      token: '{{env.POLYTOMIC_API_KEY}}'
  exposes:
  - type: rest
    namespace: polytomic-subpackage-models-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_models. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/connections/{id}/modelsync/enrichment-source
      name: api-connections-id-modelsync-enrichment-source
      description: REST surface for api-connections-id-modelsync-enrichment-source.
      operations:
      - method: GET
        name: getenrichmentsource
        description: Get Enrichment Source
        call: polytomic-subpackage-models.getenrichmentsource
        with:
          id: rest.id
          params: rest.params
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/enrichment/{connection-id}/inputfields
      name: api-enrichment-connection-id-inputfields
      description: REST surface for api-enrichment-connection_id-inputfields.
      operations:
      - method: POST
        name: post
        description: Enrichment Fields
        call: polytomic-subpackage-models.post
        with:
          connection_id: rest.connection_id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/model-preview
      name: api-model-preview
      description: REST surface for api-model-preview.
      operations:
      - method: POST
        name: preview
        description: Preview Model
        call: polytomic-subpackage-models.preview
        with:
          async: rest.async
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/models
      name: api-models
      description: REST surface for api-models.
      operations:
      - method: GET
        name: list
        description: List Models
        call: polytomic-subpackage-models.list
        with:
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: Create Model
        call: polytomic-subpackage-models.create
        with:
          async: rest.async
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/models/{id}
      name: api-models-id
      description: REST surface for api-models-id.
      operations:
      - method: GET
        name: get
        description: Get Model
        call: polytomic-subpackage-models.get
        with:
          id: rest.id
          async: rest.async
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: update
        description: Update Model
        call: polytomic-subpackage-models.update
        with:
          id: rest.id
          async: rest.async
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete Model
        call: polytomic-subpackage-models.delete
        with:
          id: rest.id
          async: rest.async
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/models/{id}/sample
      name: api-models-id-sample
      description: REST surface for api-models-id-sample.
      operations:
      - method: GET
        name: sample
        description: Sample Records
        call: polytomic-subpackage-models.sample
        with:
          id: rest.id
          async: rest.async
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: polytomic-subpackage-models-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_models. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-enrichment-source
      description: Get Enrichment Source
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-models.getenrichmentsource
      with:
        id: tools.id
        params: tools.params
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: enrichment-fields
      description: Enrichment Fields
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-models.post
      with:
        connection_id: tools.connection_id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: preview-model
      description: Preview Model
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-models.preview
      with:
        async: tools.async
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-models
      description: List Models
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-models.list
      with:
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: create-model
      description: Create Model
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-models.create
      with:
        async: tools.async
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-model
      description: Get Model
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-models.get
      with:
        id: tools.id
        async: tools.async
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: update-model
      description: Update Model
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: polytomic-subpackage-models.update
      with:
        id: tools.id
        async: tools.async
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-model
      description: Delete Model
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: polytomic-subpackage-models.delete
      with:
        id: tools.id
        async: tools.async
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: sample-records
      description: Sample Records
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-models.sample
      with:
        id: tools.id
        async: tools.async
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.