Gemstones

Update Gemstone

PUT /api/v1/gems/{id} — partial update of user-editable fields (LNK-GEMRENAME).

The save prompt's rename (app LNK-AUDITAPP) calls this feature-detected with {"name": str}; name is the piece title, stored on main_heading. Only fields the client sends change. Dual-owner resolution mirrors GET /{gem_id}/details (LNK-DETAILSANON): user_id when authenticated OR device_id via X-Device-Id, with the owner filter inside the query so a foreign gem 404s without leaking existence.

put/api/v1/gems/{gem_id}

Request

  • Base URL: https://api.gemstoneaiapp.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.gemstoneaiapp.com/api/v1/gems/{gem_id}
  • Auth: none declared

Path parameters

gem_idinteger required

Headers

X-Device-Idinteger nullable
authorizationstring nullable
X-API-Versionstring nullable

Request body

namestring nullable
name_editedboolean nullable

Response

Successful Response

idinteger required
user_idinteger nullable
scan_saved_to_collectionboolean
main_headingstring nullable
sub_headingstring nullable
descriptionstring nullable
valuation_basisobject nullable
stone_quantityinteger nullable
observed_colorsobject[] nullable
gem_speciesstring nullable
gem_species_confidenceinteger nullable
jewelry_typestring nullable
metal_typestring nullable
metal_detectedboolean
gemstone_detectedboolean
loose_gemboolean
value_trendstring nullable
primary_stonestring nullable
scan_qualitystring nullable
transparency_estimatestring nullable
carat_scopestring nullable
total_carat_weightunknown
watchobject nullable
cut_shapestring nullable
color_gradestring nullable
color_grade_confidenceinteger nullable
clarity_gradestring nullable
clarity_grade_confidenceinteger nullable
cut_gradestring nullable
cut_grade_confidenceinteger nullable
origin_gradestring nullable
origin_grade_confidenceinteger nullable
treatment_gradestring nullable
treatment_grade_confidenceinteger nullable
value_breakdownunknown
authenticityunknown
scan_versioninteger nullable
analysisunknown
compositionunknown
valueunknown
confidenceinteger nullable
specimen_formstring nullable
id_agreementstring nullable
photo_guidancestring nullable
capture_issuestring nullable
stage1_speciesstring nullable
final_speciesstring nullable
deep_scan_statusstring
deep_scan_started_atstring date-time nullable
deep_scan_completed_atstring date-time nullable
brandstring nullable
product_linestring nullable
brand_sourcestring nullable
brand_confidencenumber nullable
brand_evidencestring nullable
scan_accuracy_feedbackboolean nullable
species_sourcestring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.