Gemstones

Save Scan To Collection

POST /api/v1/gems/save/collection Save multiple scanned gemstones to user's permanent collection.

Supports saving multiple gemstones at once from a multi-gemstone scan. Limited by free saves (50 for free users, unlimited for subscribers).

LNK-LADDER: the user's FIRST successful save grants +1 bonus scan. The response items additively carry {"bonus_granted": true, "scans_remaining": n} on the grant-ing save so the app can toast it (old clients ignore the unknown fields; the array shape is unchanged).

Args: gemstone_ids: List of gemstone IDs to save

Returns: List of saved SavedGemstoneResponse objects

Raises: HTTPException 400: Invalid or missing gemstone IDs HTTPException 402: Save limit reached HTTPException 404: Some gemstones not found HTTPException 500: Database error

post/api/v1/gems/save/collection

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/save/collection
  • Auth: HTTP bearer

Headers

X-API-Versionstring nullable

Request body

gemstone_idsinteger[] required

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
bonus_grantedboolean nullable
scans_remaininginteger nullable

Changes

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