Terapi · Capability

Terapi API — Sync

Terapi API — Sync. 2 operations. Lead operation: Trigger Sync. Self-contained Naftiko capability covering one Terapi business surface.

Run with Naftiko TerapiSync

What You Can Do

POST
Triggersync — Trigger Sync
/v1/sync/trigger
GET
Getsyncstatus — Get Sync Status
/v1/sync/{connection-id}/{sync-name}

MCP Tools

trigger-sync

Trigger Sync

get-sync-status

Get Sync Status

read-only idempotent

Capability Spec

terapi-sync.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Terapi API — Sync
  description: 'Terapi API — Sync. 2 operations. Lead operation: Trigger Sync. Self-contained Naftiko capability covering
    one Terapi business surface.'
  tags:
  - Terapi
  - Sync
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TERAPI_API_KEY: TERAPI_API_KEY
capability:
  consumes:
  - type: http
    namespace: terapi-sync
    baseUri: https://api.terapi.dev
    description: Terapi API — Sync business capability. Self-contained, no shared references.
    resources:
    - name: sync-trigger
      path: /sync/trigger
      operations:
      - name: triggersync
        method: POST
        description: Trigger Sync
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sync-connection_id-sync_name
      path: /sync/{connection_id}/{sync_name}
      operations:
      - name: getsyncstatus
        method: GET
        description: Get Sync Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connection_id
          in: path
          type: string
          description: The connection identifier
          required: true
        - name: sync_name
          in: path
          type: string
          description: The name of the sync
          required: true
        - name: provider_config_key
          in: query
          type: string
          description: The provider config key
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.TERAPI_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: terapi-sync-rest
    port: 8080
    description: REST adapter for Terapi API — Sync. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/sync/trigger
      name: sync-trigger
      description: REST surface for sync-trigger.
      operations:
      - method: POST
        name: triggersync
        description: Trigger Sync
        call: terapi-sync.triggersync
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sync/{connection-id}/{sync-name}
      name: sync-connection-id-sync-name
      description: REST surface for sync-connection_id-sync_name.
      operations:
      - method: GET
        name: getsyncstatus
        description: Get Sync Status
        call: terapi-sync.getsyncstatus
        with:
          connection_id: rest.connection_id
          sync_name: rest.sync_name
          provider_config_key: rest.provider_config_key
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: terapi-sync-mcp
    port: 9090
    transport: http
    description: MCP adapter for Terapi API — Sync. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: trigger-sync
      description: Trigger Sync
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: terapi-sync.triggersync
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-sync-status
      description: Get Sync Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: terapi-sync.getsyncstatus
      with:
        connection_id: tools.connection_id
        sync_name: tools.sync_name
        provider_config_key: tools.provider_config_key
      outputParameters:
      - type: object
        mapping: $.