Documentation

Guides to Cutwise screens and services, and the Platform API reference.

This section explains how to work with Cutwise: stock and projects, grading services, sharing, billing, and the Platform API.

  • Stock and Projects

    Get diamonds, rough diamonds and projects into Cutwise, and decide who may see them.

    • Stock Management

      Publish your diamonds, rough diamonds and projects to Cutwise, and control who may see them.

  • Grading Services

    How Cutwise estimates the color of rough diamonds and of the diamonds planned from them, and how the color grading demo works.

    • Color Grading Demo

      Grade the color of demo diamonds against color references, and see the grades on Cutwise pages.

  • Platform API

    The public REST API for managing diamonds on Cutwise from your own systems.

    • API Conventions

      How the API handles redirects, which HTTP methods it uses and how to send timestamps.

    • API Authorization

      Getting an OAuth 2.0 access token and sending it with every API request.

    • Constants API

      Dictionaries and technical constants that the other APIs refer to by id.

    • Diamonds API v4

      Managing a vendor's diamonds published on Cutwise, with grades as plain string values.

    • Diamonds API v4: Accepted Values

      The values Diamonds API v4 accepts for shape, color, clarity and the other grades.

    • Certifications API v4

      Attaching a lab certificate to a diamond and removing it.

    • Diamonds API v3

      Managing a vendor's diamonds, with grades as ids from the Constants API dictionaries.

    • Media Meta API

      Reading the DiBox and ViBox metadata of uploaded media by diamond, project or setup preset.

    • API Error Handling

      HTTP status codes the API returns and what a client should do with each.

    • Optical Performance Scores in the API

      How the API encodes Fire, Brilliance, Spread and Fluorescence scores and their scale.

    • Fancy Color Grades in the API

      The Munsell hue, value and chroma fields the API returns for a fancy colored diamond.

    • API Examples

      JavaScript examples that sign in and call Diamonds API v3 and v4.

For background on diamond optics and grading, see the Knowledge base. For what changed in each version, see the Release notes.