Sinch Conversation API — Conversations

naftiko: 1.0.0-alpha2
info:
  label: Sinch Conversation API — Conversations
  description: 'Sinch Conversation API — Conversations. 6 operations. Lead operation: List Conversations. Self-contained Naftiko
    capability covering one Sinch business surface.'
  tags:
  - Sinch
  - Conversations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SINCH_API_KEY: SINCH_API_KEY
capability:
  consumes:
  - type: http
    namespace: conversation-conversations
    baseUri: https://us.conversation.api.sinch.com
    description: Sinch Conversation API — Conversations business capability. Self-contained, no shared references.
    resources:
    - name: v1-projects-project_id-conversations
      path: /v1/projects/{project_id}/conversations
      operations:
      - name: listconversations
        method: GET
        description: List Conversations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: only_active
          in: query
          type: boolean
          description: Only return active conversations
        - name: app_id
          in: query
          type: string
          description: Filter by app ID
        - name: contact_id
          in: query
          type: string
          description: Filter by contact ID
        - name: page_size
          in: query
          type: integer
          description: The number of conversations per page
        - name: page_token
          in: query
          type: string
          description: Pagination token for the next page
      - name: createconversation
        method: POST
        description: Create a Conversation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-projects-project_id-conversations-conversation_id
      path: /v1/projects/{project_id}/conversations/{conversation_id}
      operations:
      - name: getconversation
        method: GET
        description: Get a Conversation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateconversation
        method: PATCH
        description: Update a Conversation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteconversation
        method: DELETE
        description: Delete a Conversation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-projects-project_id-conversations-conversation_id}:stop
      path: /v1/projects/{project_id}/conversations/{conversation_id}:stop
      operations:
      - name: stopconversation
        method: POST
        description: Stop a Conversation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SINCH_API_KEY}}'
  exposes:
  - type: rest
    namespace: conversation-conversations-rest
    port: 8080
    description: REST adapter for Sinch Conversation API — Conversations. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/projects/{project-id}/conversations
      name: v1-projects-project-id-conversations
      description: REST surface for v1-projects-project_id-conversations.
      operations:
      - method: GET
        name: listconversations
        description: List Conversations
        call: conversation-conversations.listconversations
        with:
          only_active: rest.only_active
          app_id: rest.app_id
          contact_id: rest.contact_id
          page_size: rest.page_size
          page_token: rest.page_token
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createconversation
        description: Create a Conversation
        call: conversation-conversations.createconversation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/projects/{project-id}/conversations/{conversation-id}
      name: v1-projects-project-id-conversations-conversation-id
      description: REST surface for v1-projects-project_id-conversations-conversation_id.
      operations:
      - method: GET
        name: getconversation
        description: Get a Conversation
        call: conversation-conversations.getconversation
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateconversation
        description: Update a Conversation
        call: conversation-conversations.updateconversation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteconversation
        description: Delete a Conversation
        call: conversation-conversations.deleteconversation
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/projects/{project-id}/conversations/conversation-id-stop
      name: v1-projects-project-id-conversations-conversation-id-stop
      description: REST surface for v1-projects-project_id-conversations-conversation_id}:stop.
      operations:
      - method: POST
        name: stopconversation
        description: Stop a Conversation
        call: conversation-conversations.stopconversation
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: conversation-conversations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sinch Conversation API — Conversations. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-conversations
      description: List Conversations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: conversation-conversations.listconversations
      with:
        only_active: tools.only_active
        app_id: tools.app_id
        contact_id: tools.contact_id
        page_size: tools.page_size
        page_token: tools.page_token
      outputParameters:
      - type: object
        mapping: $.
    - name: create-conversation
      description: Create a Conversation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: conversation-conversations.createconversation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-conversation
      description: Get a Conversation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: conversation-conversations.getconversation
      outputParameters:
      - type: object
        mapping: $.
    - name: update-conversation
      description: Update a Conversation
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: conversation-conversations.updateconversation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-conversation
      description: Delete a Conversation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: conversation-conversations.deleteconversation
      outputParameters:
      - type: object
        mapping: $.
    - name: stop-conversation
      description: Stop a Conversation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: conversation-conversations.stopconversation
      outputParameters:
      - type: object
        mapping: $.