APIs.io Engineering Platform Web Search Client — WebSearch

naftiko: 1.0.0-alpha2
info:
  label: APIs.io Engineering Platform Web Search Client — WebSearch
  description: 'APIs.io Engineering Platform Web Search Client — WebSearch. 1 operations. Lead operation: APIs.io Engineering
    Platform The Web Search API lets you send a search query to Bing and get back search results that include links to webpages,
    images, and more.. Self-contained Naftiko capability covering one Engineering Platform business surface.'
  tags:
  - Engineering Platform
  - WebSearch
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ENGINEERING_PLATFORM_API_KEY: ENGINEERING_PLATFORM_API_KEY
capability:
  consumes:
  - type: http
    namespace: microsoft-cognitive-web-search-websearch
    baseUri: https://api.cognitive.microsoft.com/bing/v7.0
    description: APIs.io Engineering Platform Web Search Client — WebSearch business capability. Self-contained, no shared
      references.
    resources:
    - name: search
      path: /search
      operations:
      - name: websearch
        method: GET
        description: APIs.io Engineering Platform The Web Search API lets you send a search query to Bing and get back search
          results that include links to webpages, images, and more.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-BingApis-SDK
          in: header
          type: string
          description: Activate swagger compliance
          required: true
        - name: Accept
          in: header
          type: string
          description: The default media type is application/json. To specify that the response use [JSON-LD](http://json-ld.org/),
            set the Accept header to application/ld+json.
        - name: Accept-Language
          in: header
          type: string
          description: A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing
            order of preference. For additional information, in
        - name: Pragma
          in: header
          type: string
          description: 'By default, Bing returns cached content, if available. To prevent Bing from returning cached content,
            set the Pragma header to no-cache (for example, Pragma: no'
        - name: User-Agent
          in: header
          type: string
          description: The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized
            experience. Although optional, you are strongly encou
        - name: X-MSEdge-ClientID
          in: header
          type: string
          description: 'Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often
            flights new features and improvements, and it uses the client '
        - name: X-MSEdge-ClientIP
          in: header
          type: string
          description: The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location.
            Bing uses the location information to determine safe sear
        - name: X-Search-Location
          in: header
          type: string
          description: A semicolon-delimited list of key/value pairs that describe the client's geographical location. Bing
            uses the location information to determine safe search beha
        - name: answerCount
          in: query
          type: integer
          description: 'The number of answers that you want the response to include. The answers that Bing returns are based
            on ranking. For example, if Bing returns webpages, images, '
        - name: cc
          in: query
          type: string
          description: 'A 2-character country code of the country where the results come from. This API supports only the
            United States market. If you specify this query parameter, it '
        - name: count
          in: query
          type: integer
          description: The number of search results to return in the response. The default is 10 and the maximum value is
            50. The actual number delivered may be less than requested.Us
        - name: freshness
          in: query
          type: string
          description: 'Filter search results by the following age values: Day—Return webpages that Bing discovered within
            the last 24 hours. Week—Return webpages that Bing discovered '
        - name: mkt
          in: query
          type: string
          description: The market where the results come from. Typically, mkt is the country where the user is making the
            request from. However, it could be a different country if the
        - name: offset
          in: query
          type: integer
          description: The zero-based offset that indicates the number of search results to skip before returning results.
            The default is 0. The offset should be less than (totalEstim
        - name: promote
          in: query
          type: array
          description: A comma-delimited list of answers that you want the response to include regardless of their ranking.
            For example, if you set answerCount) to two (2) so Bing ret
        - name: q
          in: query
          type: string
          description: The user's search query term. The term may not be empty. The term may contain Bing Advanced Operators.
            For example, to limit results to a specific domain, use t
          required: true
        - name: responseFilter
          in: query
          type: array
          description: A comma-delimited list of answers to include in the response. If you do not specify this parameter,
            the response includes all search answers for which there's r
        - name: safeSearch
          in: query
          type: string
          description: 'A filter used to filter adult content. Off: Return webpages with adult text, images, or videos. Moderate:
            Return webpages with adult text, but not adult images '
        - name: setLang
          in: query
          type: string
          description: The language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language
            code. For example, the language code for English is E
        - name: textDecorations
          in: query
          type: boolean
          description: 'A Boolean value that determines whether display strings should contain decoration markers such as
            hit highlighting characters. If true, the strings may include '
        - name: textFormat
          in: query
          type: string
          description: The type of markers to use for text decorations (see the textDecorations query parameter). Possible
            values are Raw—Use Unicode characters to mark content that n
    authentication:
      type: apikey
      key: Ocp-Apim-Subscription-Key
      value: '{{env.ENGINEERING_PLATFORM_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: microsoft-cognitive-web-search-websearch-rest
    port: 8080
    description: REST adapter for APIs.io Engineering Platform Web Search Client — WebSearch. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/search
      name: search
      description: REST surface for search.
      operations:
      - method: GET
        name: websearch
        description: APIs.io Engineering Platform The Web Search API lets you send a search query to Bing and get back search
          results that include links to webpages, images, and more.
        call: microsoft-cognitive-web-search-websearch.websearch
        with:
          X-BingApis-SDK: rest.X-BingApis-SDK
          Accept: rest.Accept
          Accept-Language: rest.Accept-Language
          Pragma: rest.Pragma
          User-Agent: rest.User-Agent
          X-MSEdge-ClientID: rest.X-MSEdge-ClientID
          X-MSEdge-ClientIP: rest.X-MSEdge-ClientIP
          X-Search-Location: rest.X-Search-Location
          answerCount: rest.answerCount
          cc: rest.cc
          count: rest.count
          freshness: rest.freshness
          mkt: rest.mkt
          offset: rest.offset
          promote: rest.promote
          q: rest.q
          responseFilter: rest.responseFilter
          safeSearch: rest.safeSearch
          setLang: rest.setLang
          textDecorations: rest.textDecorations
          textFormat: rest.textFormat
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: microsoft-cognitive-web-search-websearch-mcp
    port: 9090
    transport: http
    description: MCP adapter for APIs.io Engineering Platform Web Search Client — WebSearch. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: apis-io-engineering-platform-web-search
      description: APIs.io Engineering Platform The Web Search API lets you send a search query to Bing and get back search
        results that include links to webpages, images, and more.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: microsoft-cognitive-web-search-websearch.websearch
      with:
        X-BingApis-SDK: tools.X-BingApis-SDK
        Accept: tools.Accept
        Accept-Language: tools.Accept-Language
        Pragma: tools.Pragma
        User-Agent: tools.User-Agent
        X-MSEdge-ClientID: tools.X-MSEdge-ClientID
        X-MSEdge-ClientIP: tools.X-MSEdge-ClientIP
        X-Search-Location: tools.X-Search-Location
        answerCount: tools.answerCount
        cc: tools.cc
        count: tools.count
        freshness: tools.freshness
        mkt: tools.mkt
        offset: tools.offset
        promote: tools.promote
        q: tools.q
        responseFilter: tools.responseFilter
        safeSearch: tools.safeSearch
        setLang: tools.setLang
        textDecorations: tools.textDecorations
        textFormat: tools.textFormat
      outputParameters:
      - type: object
        mapping: $.