API Reference | DreamAlign

Authentication

Endpoints for signing in, token refresh, account management, and API key registration.

POST /api/authentication/Connect Public

Authenticates a user and returns bearer + refresh tokens.

Form Body

Field	Type	Description
`userName`	string	User email address
`password`	string	Account password

Response 200

{
    "bearerToken": "eyJhbGci...",
    "refreshToken": "dGhpcyBp..."
}

POST /api/authentication/ConnectWithApiKey Public

Authenticates using an API key and returns bearer + refresh tokens.

Form Body

Field	Type	Description
`apiKey`	string	Your API key

Response 200

{
    "bearerToken": "eyJhbGci...",
    "refreshToken": "dGhpcyBp..."
}

Cases

Create, retrieve, and manage DreamAlign cases, and fingerprints(trays). All endpoints in this section require a Member-level bearer token unless noted otherwise.

POST /api/case/FinalizeCaseCreation Member

Finalizes a case after all fingerprints have been uploaded: builds the .da package and queues each fingerprint for prediction. Requires a .cfg to already be uploaded for every fingerprint in the case.

Query Parameters

Name	Type	Description
`caseName`	string	Name of the case
`caseIdentifier`	string	Case unique identifier
`overwrite`	string	`"1"` to re-finalize an already-finalized case, otherwise `"0"`

POST /api/case/GetFingerPrint Member

Returns the fingerprint ID for a tray within a case.

Form Body

Field	Type	Description
`caseName`	string	Name of the case
`caseIdentifier`	string	Case unique identifier
`trayName`	string	Target tray name

Response 200

{ "FingerPrint": 6841235907512345 }

POST /api/case/GetFingerPrintInfo Member

Returns the current processing stage and review flags for a fingerprint.

Form Body

Field	Type	Description
`fingerPrint`	string	Fingerprint ID

Response 200

{
    "QC": "Done",
    "Prediction": "Done",
    "Cutline": "Done",
    "Export": "Done",
    "Basing": "No",
    "BracketRemoval": "No",
    "ReviewDone": "Yes",
    "ExternalRejection": "No",
    "HGUID": "e3b0c442-98fc-1c14-9afb-f4c8996fb924"
}

GET /api/case/DownloadMeshExport Member

Downloads the processed/exported mesh (.stl).

Query Parameters

Name	Type	Description
`fingerprint`	string	Fingerprint ID

GET /api/case/DownloadMeshPTS Member

Converts a fingerprint's .cnc file to a plain-text point/angle list (.pts)

Query Parameters

Name	Type	Description
`fingerprint`	string	Fingerprint ID

GET /api/case/DownloadMesh Member

Downloads the original uploaded mesh (.stl)

Query Parameters

Name	Type	Description
`fingerprint`	string	Fingerprint ID from GetFingerPrint

GET /api/case/DownloadPrediction Member

Downloads the AI prediction file (.pre)

Query Parameters

Name	Type	Description
`fingerprint`	string	Fingerprint ID

GET /api/case/DownloadMasterCutline Member

Downloads the master cutline file (.mcl)

Query Parameters

Name	Type	Description
`fingerprint`	string	Fingerprint ID

POST /api/case/UploadTray Member

Uploads a tray mesh for a case/identifier, attaching it to (or creating) the case and deducting one credit for newly-seen fingerprints.

Query Parameters

Name	Type	Description
`trayName`	string	Tray name
`jawType`	string	`man` (mandibular) or `max` (maxillar)
`caseName`	string	Name of the case
`caseIdentifier`	string	Case unique identifier
`skipExportValidation`	string	`"1"` to skip export validation, otherwise `"0"`
`dropId`	string	Drop ID uploading the tray
`trayNumber`	string	Optional tray number
`profile`	string	Optional config profile name

Request Body

Format	Description
`application/octet-stream`	Binary `.stl` mesh (minimum 84 bytes)

POST /api/case/UploadConfig Member

Uploads a configuration file for a specific fingerprint. All fingerprints need a .cfg

Query Parameters

Name	Type	Description
`fingerPrint`	string	Target fingerprint ID

Request Body

Format	Description
`application/octet-stream`	Binary `.cfg` file

Example .cfg file

[Cutline management]
Facial gum offset=1.30
Lingual gum offset=1.30
Facial smoothing=10.00
Lingual smoothing=10.00
Facial cut line=Straight
Lingual cut line=Straight
Cutline over teeth=No

[Cnc management]
Facial Angle=30.00
Lingual Angle=30.00
Collision Check=No
Collision Threshold=2.00

[Export management]
Auto basing=Yes
Auto bracket=Yes
Auto midline=Yes
Block out undercut=No
Block out proximal=No
Block out proximal distance=1.00
Indirect bonding tray=No
Bleach tray=No
Bleach thickness=0.25
Print vertical=No
Print vertical angle=0.00
Basing length=5.00
Basing offset=2.00
Basing transition offset=2.00
Retainer Sport facial percent=0.50
Retainer Sport right facial percent=0.50
Direct print=No
Print thickness=0.70
Simplify tray=Yes
Simplify percent=40.00
Height adjustment=Yes
Hollowing=Yes
Hollow thickness=4.00
Engrave path=No
Engrave thickness=1.00
Clean=No
Clean Mode=QC
Retainer type=Essix
Basing type=Horseshoe
Splint design=None
Fixture type=Ortho_Automation