action gettyimages_get_v3_search_images_creative_by_image {
  label: "Search for creative images based on url"
  description: "Search for **similar creative images** by passing an `image_url` to an uploaded image OR an `asset_id` of an asset in our catalog.  All responses will have the `exclude_nudity` filter automatically applied.\n\n## Searching by URL\n\nBefore calling the search by image endpoint, an image in JPEG format must be uploaded to `https://api.gettyimages.com/v3/search/by-image/uploads/{CLIENT_IMAGE.jpg}`, where the client defines the `{CLIENT_IMAGE.jpg}` portion of the URL.\n\nFor example, using cURL:\n\n``` sh\ncurl -i -X PUT https://api.gettyimages.com/v3/search/by-image/uploads/my-test-image.jpg -H 'Content-Type: image/jpeg' -H 'Api-Key: API_KEY' --data-binary \"@testimage.jpg\"\n```\n\nOnce the image has been uploaded, use the full URL in the `image_url` parameter, e.g. `image_url=https://api.gettyimages.com/v3/search/by-image/uploads/my-test-image.jpg`.\n\n- Uploaded files must be 10MB or smaller.\n- Uploads to the same URL will overwrite each other, so ensure that the client application is handling naming uniqueness appropriately.\n- Uploads expire after 24 hours.\n- Uploads and searches must be performed using the _same_ API Key.\n\n## Searching by asset id\n\nWhen searching by `asset_id`, any image or video asset id in the Getty/iStock catalog can be used as the source for similar images.\n"
  provider: gettyimages
  method: GET
  path: "/v3/search/images/creative/by-image"
  encoding: json
  input: {
    type: "object"
    properties: {
      "Accept-Language": {
        type: "string"
        description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
      }
      "GI-Country-Code": {
        type: "string"
        description: "Use of this parameter requires configuration changes to your API key. Please contact your sales representative to learn more."
      }
      asset_id: {
        type: "string"
        description: "Specifies the Getty image id to use in the search."
      }
      exclude_editorial_use_only: {
        type: "boolean"
        description: "Exclude images that are only available for editorial (non-commercial) use. Default value is false."
      }
      facet_fields: {
        type: "array"
        description: "Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.
\n                    The include_facets parameter must be set to \"true\" for facets to be returned."
        items: {
          type: "string"
          enum: ["artists", "locations"]
        }
      }
      facet_max_count: {
        type: "integer"
        format: "int32"
        description: "Specifies the maximum number of facets to return per type. Default is 300."
      }
      fields: {
        type: "array"
        description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
        items: {
          type: "string"
          enum: ["allowed_use", "alternative_ids", "artist", "asset_family", "call_for_image", "caption", "collection_code", "collection_id", "collection_name", "color_type", "comp", "copyright", "date_camera_shot", "date_created", "date_submitted", "detail_set", "display_set", "download_product", "download_sizes", "graphical_style", "id", "istock_collection", "keywords", "largest_downloads", "license_model", "max_dimensions", "orientation", "preview", "product_types", "quality_rank", "referral_destinations", "summary_set", "thumb", "title", "uri_oembed"]
        }
      }
      image_url: {
        type: "string"
        description: "Specifies the location of the image to use in the search."
      }
      include_facets: {
        type: "boolean"
        description: "Specifies whether or not to include facets in the result set. Default is \"false\"."
      }
      page: {
        type: "integer"
        format: "int32"
        description: "Request results starting at a page number (default is 1)."
      }
      page_size: {
        type: "integer"
        format: "int32"
        description: "Request number of images to return in each page. Default is 30, maximum page_size is 100."
      }
      product_types: {
        type: "array"
        description: "Filter images to those from one of your product types. 
\n                    Allowed values are easyaccess, imagepack, premiumaccess and royaltyfreesubscription. 
\n                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. 
\n                    For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234. 
\n                    Product ID can be obtained from the GET /products response."
        items: {
          type: "string"
        }
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      auto_corrections: {
        type: "object"
        properties: {
          phrase: {
            type: "string"
          }
        }
        additionalProperties: false
      }
      facets: {
        type: "object"
        properties: {
          artists: {
            type: "array"
            items: {
              type: "object"
              properties: {
                name: {
                  type: "string"
                }
              }
              additionalProperties: false
            }
          }
          entertainment: {
            type: "array"
            items: {
              type: "object"
              properties: {
                id: {
                  type: "integer"
                  format: "int32"
                }
                name: {
                  type: "string"
                }
              }
              additionalProperties: false
            }
          }
          events: {
            type: "array"
            items: {
              type: "object"
              properties: {
                date: {
                  type: "string"
                  format: "date-time"
                }
                id: {
                  type: "integer"
                  format: "int32"
                }
                name: {
                  type: "string"
                }
              }
              additionalProperties: false
            }
          }
          locations: {
            type: "array"
            items: {
              type: "object"
              properties: {
                id: {
                  type: "integer"
                  format: "int32"
                }
                name: {
                  type: "string"
                }
              }
              additionalProperties: false
            }
          }
          specific_people: {
            type: "array"
            items: {
              type: "object"
              properties: {
                id: {
                  type: "integer"
                  format: "int32"
                }
                name: {
                  type: "string"
                }
              }
              additionalProperties: false
            }
          }
        }
        additionalProperties: false
      }
      image_fingerprint: {
        type: "string"
      }
      images: {
        type: "object"
      }
      related_searches: {
        type: "array"
        items: {
          type: "object"
          properties: {
            phrase: {
              type: "string"
            }
            url: {
              type: "string"
            }
          }
          additionalProperties: false
        }
      }
      result_count: {
        type: "integer"
        format: "int32"
      }
    }
    additionalProperties: false
  }
}