Quick Start Guide

Welcome to the Dentscape Smile Simulation API! This guide will walk you through the process of getting your API key and making your first request using our asynchronous workflow.

Step 1: Obtain an API Key

To access our API, you need an API key.

1. Visit our API Portal: <https://smile.dentscape.ai>
2. Sign up for an account or log in.
3. Navigate to the Developers > API Keys section to generate a new key.
4. Copy your API key and keep it secure. You will need it for all API requests.

Step 2: Submit a Simulation or Analysis Task

Our API uses an asynchronous workflow. You submit a task, receive a task_id, and then poll for the results.

Example: Orthodontic Simulation

Make a POST request to /v1/simulations/orthodontics with your image URL.

Request:

Bash

curl -X POST "https://dentscape.site/v1/simulations/orthodontics" \
     -H "X-Api-Key: YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
           "image_url": "https://example.com/face.jpg"
         }'

Response:

JSON

{
    "task_id": "test_task_id",
    "status": "PENDING"
}

Step 3: Poll for Results

Use the task_id from the previous step to check the status of your task.

Request:

Bash

curl -X GET "https://dentscape.site/v1/tasks/test_task_id" \
     -H "X-Api-Key: YOUR_API_KEY"

Response (Processing):

JSON

{
    "status": "STARTED",
    "results": null,
    "payload": null,
    "timestamp": "2025-12-11T10:00:00Z"
}

Response (Success):

JSON

{
    "status": "SUCCESS",
    "results": "{\"after_image\": \"https://result-image-url.com/output.jpg\"}",
    "payload": {
        "after_image": "https://result-image-url.com/output.jpg"
    },
    "timestamp": "2025-12-11T10:00:05Z"
}

Once the status is SUCCESS, you can find your output in the payload field (recommended) or parse the results JSON string.

Error Handling

If the status is FAILURE, the results field or the error response will contain details about what went wrong. Refer to the Error Handling section in the API Documentation for more details.

WordPress Plugin

We also provide a WordPress Plugin for easy integration. See the WordPress Plugin Guide for installation and configuration instructions.