POST
/
api
/
v2
/
diamonds
/
ai_search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
weight
number
required

Weight of the diamond.

shape
string
required

Shape to perform the AI search on.

types
enum<string>[]
required
Available options:
mined,
lab grown
currency_code
string

ISO-3 currency code to return the prices in. Defaults to USD.

count_per_grade
integer

Determines if to return 1 result or 2 result per template. Use 1 for single and 2 for pair.

Required range: 1 < x < 2
ratio_min
number
ratio_max
number
merchant_template_filters
object

Response

200 - application/json
OK
allow_media_request
boolean
base_currency_code
string
base_retail_price
integer
base_wholesale_price
integer
bgm
null
brand
null
cached_ux_url
string | null
can_hold
boolean
cert_num
string
cert_url
string
city
null
clarity
string
clarity_max
null
color
string
color_max
null
country_code
string
created_on
string
crown_angle
number | null
culet_size
string | null
currency_code
string
cut_code
string
cut_grade
null
cut_grade_description
null
days_to_return
integer
delivery_days_max
integer
delivery_days_min
integer
depth
number
depth_percentage
number
disabled_at
null
disabled_reason
null
display_origin
null
enabled
boolean
exchange_rate
integer
eye_clean
string
eye_clean_grade
null
fancy_color_intensity
null
fluorescence
string
girdle_max
string
girdle_min
string
grading_status
string
grow_method
string | null
hold_merchant_uuid
null
id
integer
image_bottom_url
null
image_top_url
string
internal_days_to_return
integer
is_bgm
boolean
is_fancy
boolean
is_manual
boolean
is_pair
boolean
is_sustainable
boolean
lab
string
length
number
luster
null
manually_disabled
boolean
media_requested
boolean
memo
boolean
memo_days_to_return
integer
merchant_template_group
string
merchant_template_label
string

The label of the merchant template to the diamond was classified under. For example, if the label of the merchant template is "ideal", then the label will return "ideal" in the response.

merchant_template_position
integer
merchant_template_uuid
string
off_rap_percentage
null
on_hand_video_url
null
on_hold
boolean
open_crown
null
open_girdle
null
open_pavilion
null
open_table
null
origin
null
original_imported_ext_url
string
overtone
null
parcel
boolean
pavilion_angle
number | null
pavilion_depth
number | null
pcs
integer
polish_grade
string
product_type
string
quality
null
quantity
integer
ratio
number
ratio_group
string
retail_cert_url
string
retail_price
integer
returnable
boolean | null
shade
null
shape
string
shape_icon_url
string
shape_icon_url_png
string
shape_image_url
string
sku
string
stone_type
null
sustainability_details
null
symmetry_grade
string
table_percentage
integer
tone
null
treatments
null
type
string
uom
string
updated_on
string
ux_url
string
v360_info
null
v360_json_base_url
string
video_url
string
weight
number
wholesale_price
integer
width
number