Microsoft Azure Custom Image Search Client — CustomImageSearch

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure Custom Image Search Client — CustomImageSearch
  description: 'Microsoft Azure Custom Image Search Client — CustomImageSearch. 1 operations. Lead operation: Microsoft Azure
    The Custom Image Search Api Lets You Send An Image Search Query To Bing And Get Image Results Found In Your Custom View
    Of The Web. Self-contained Naftiko capability covering one Microsoft Azure business surface.'
  tags:
  - Microsoft Azure
  - CustomImageSearch
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_API_KEY: MICROSOFT_AZURE_API_KEY
capability:
  consumes:
  - type: http
    namespace: custom-image-search-client-customimagesearch
    baseUri: https://api.cognitive.microsoft.com/bingcustomsearch/v7.0
    description: Microsoft Azure Custom Image Search Client — CustomImageSearch business capability. Self-contained, no shared
      references.
    resources:
    - name: images-search
      path: /images/search
      operations:
      - name: microsoftazurecustominstanceimagesearch
        method: GET
        description: Microsoft Azure The Custom Image Search Api Lets You Send An Image Search Query To Bing And Get Image
          Results Found In Your Custom View Of The Web
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - 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: 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 encouraged to '
        - 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: customConfig
          in: query
          type: string
          description: The identifier for the custom search configuration
          required: true
        - name: aspect
          in: query
          type: string
          description: 'Filter images by the following aspect ratios. All: Do not filter by aspect.Specifying this value is
            the same as not specifying the aspect parameter. Square: Ret'
        - name: color
          in: query
          type: string
          description: 'Filter images by the following color options. ColorOnly: Return color images. Monochrome: Return black
            and white images. Return images with one of the following'
        - name: cc
          in: query
          type: string
          description: A 2-character country code of the country where the results come from. For a list of possible values,
            see [Market Codes](https://docs.microsoft.com/en-us/rest/a
        - name: count
          in: query
          type: integer
          description: The number of images to return in the response. The actual number delivered may be less than requested.
            The default is 35. The maximum value is 150. You use thi
        - name: freshness
          in: query
          type: string
          description: 'Filter images by the following discovery options. Day: Return images discovered by Bing within the
            last 24 hours. Week: Return images discovered by Bing within '
        - name: height
          in: query
          type: integer
          description: Filter images that have the specified height, in pixels. You may use this filter with the size filter
            to return small images that have a height of 150 pixels.
        - name: id
          in: query
          type: string
          description: An ID that uniquely identifies an image. Use this parameter to ensure that the specified image is the
            first image in the list of images that Bing returns. The [
        - name: imageContent
          in: query
          type: string
          description: 'Filter images by the following content types. Face: Return images that show only a person''s face.
            Portrait: Return images that show only a person''s head and sho'
        - name: imageType
          in: query
          type: string
          description: 'Filter images by the following image types. AnimatedGif: Return only animated GIFs. Clipart: Return
            only clip art images. Line: Return only line drawings. Photo'
        - name: license
          in: query
          type: string
          description: 'Filter images by the following license types. All: Do not filter by license type.Specifying this value
            is the same as not specifying the license parameter. Any:'
        - 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: maxFileSize
          in: query
          type: integer
          description: Filter images that are less than or equal to the specified file size. The maximum file size that you
            may specify is 520,192 bytes. If you specify a larger value
        - name: maxHeight
          in: query
          type: integer
          description: 'Filter images that have a height that is less than or equal to the specified height. Specify the height
            in pixels. You may specify this filter and minHeight to '
        - name: maxWidth
          in: query
          type: integer
          description: Filter images that have a width that is less than or equal to the specified width. Specify the width
            in pixels. You may specify this filter and maxWidth to filt
        - name: minFileSize
          in: query
          type: integer
          description: Filter images that are greater than or equal to the specified file size. The maximum file size that
            you may specify is 520,192 bytes. If you specify a larger va
        - name: minHeight
          in: query
          type: integer
          description: 'Filter images that have a height that is greater than or equal to the specified height. Specify the
            height in pixels. You may specify this filter and maxHeight '
        - name: minWidth
          in: query
          type: integer
          description: Filter images that have a width that is greater than or equal to the specified width. Specify the width
            in pixels. You may specify this filter and maxWidth to f
        - name: offset
          in: query
          type: integer
          description: The zero-based offset that indicates the number of images to skip before returning images. The default
            is 0. The offset should be less than ([totalEstimatedMatc
        - name: q
          in: query
          type: string
          description: The user's search query term. The term cannot be empty. The term may contain [Bing Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx).
            For exa
          required: true
        - name: safeSearch
          in: query
          type: string
          description: 'Filter images for adult content. The following are the possible filter values. Off: May return images
            with adult content. If the request is through the Image Se'
        - name: size
          in: query
          type: string
          description: 'Filter images by the following sizes. All: Do not filter by size. Specifying this value is the same
            as not specifying the size parameter. Small: Return images t'
        - 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: width
          in: query
          type: integer
          description: Filter images that have the specified width, in pixels. You may use this filter with the size filter
            to return small images that have a width of 150 pixels.
  exposes:
  - type: rest
    namespace: custom-image-search-client-customimagesearch-rest
    port: 8080
    description: REST adapter for Microsoft Azure Custom Image Search Client — CustomImageSearch. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/images/search
      name: images-search
      description: REST surface for images-search.
      operations:
      - method: GET
        name: microsoftazurecustominstanceimagesearch
        description: Microsoft Azure The Custom Image Search Api Lets You Send An Image Search Query To Bing And Get Image
          Results Found In Your Custom View Of The Web
        call: custom-image-search-client-customimagesearch.microsoftazurecustominstanceimagesearch
        with:
          Accept: rest.Accept
          Accept-Language: rest.Accept-Language
          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
          customConfig: rest.customConfig
          aspect: rest.aspect
          color: rest.color
          cc: rest.cc
          count: rest.count
          freshness: rest.freshness
          height: rest.height
          id: rest.id
          imageContent: rest.imageContent
          imageType: rest.imageType
          license: rest.license
          mkt: rest.mkt
          maxFileSize: rest.maxFileSize
          maxHeight: rest.maxHeight
          maxWidth: rest.maxWidth
          minFileSize: rest.minFileSize
          minHeight: rest.minHeight
          minWidth: rest.minWidth
          offset: rest.offset
          q: rest.q
          safeSearch: rest.safeSearch
          size: rest.size
          setLang: rest.setLang
          width: rest.width
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: custom-image-search-client-customimagesearch-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Azure Custom Image Search Client — CustomImageSearch. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: microsoft-azure-custom-image-search
      description: Microsoft Azure The Custom Image Search Api Lets You Send An Image Search Query To Bing And Get Image Results
        Found In Your Custom View Of The Web
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: custom-image-search-client-customimagesearch.microsoftazurecustominstanceimagesearch
      with:
        Accept: tools.Accept
        Accept-Language: tools.Accept-Language
        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
        customConfig: tools.customConfig
        aspect: tools.aspect
        color: tools.color
        cc: tools.cc
        count: tools.count
        freshness: tools.freshness
        height: tools.height
        id: tools.id
        imageContent: tools.imageContent
        imageType: tools.imageType
        license: tools.license
        mkt: tools.mkt
        maxFileSize: tools.maxFileSize
        maxHeight: tools.maxHeight
        maxWidth: tools.maxWidth
        minFileSize: tools.minFileSize
        minHeight: tools.minHeight
        minWidth: tools.minWidth
        offset: tools.offset
        q: tools.q
        safeSearch: tools.safeSearch
        size: tools.size
        setLang: tools.setLang
        width: tools.width
      outputParameters:
      - type: object
        mapping: $.