TaiKit API

Task Types

Image to 3D Model
Convert a single image into a 3D model

Input Format

{
  "image_url": "string - URL of the uploaded image (must be from our CDN)"
}

Output Format

{
  "preview": "string - URL to a rotating preview video of the 3D model",
  "output": {
    "model_url": "string - URL to download the GLB file"
  }
}

Status Flow

  • waiting - Task is queued
  • processing - Converting image to 3D
  • preview - Preview video is ready
  • success - Final 3D model is ready
Text to Image
Generate images from text descriptions (Coming Soon)

Input Format

{
  "prompt": "string - Text description of the desired image"
}

Output Format

{
  "output": {
    "image_urls": "string[] - Array of URLs to generated images"
  }
}

Status Flow

  • waiting - Task is queued
  • processing - Generating images
  • success - Images are ready

API Endpoints

Upload Asset
POST/api/v1/assets
Upload an image file to be used in generations

Request

Content-Type: multipart/form-data
{
  "file": "File (image/*, max 30MB)"
}

Response

{
  "url": "string - The CDN URL of the uploaded file"
}
Create Image-to-3D Task
POST/api/v1/generations/image-to-3d
Convert an image into a 3D model

Request

Content-Type: application/json
{
  "image_url": "string - URL of the uploaded image"
}

Response

{
  "id": "string - Task ID",
  "type": "string - 'image-to-3d'",
  "status": "string - 'waiting'"
}
Get Task Status
GET/api/v1/generations/{taskId}
Check the status of a generation task

Response

{
  "id": "string - Task ID",
  "type": "string - Task type",
  "status": "string - 'waiting' | 'processing' | 'preview' | 'success' | 'failed'",
  "preview": "string? - Preview video URL (when status is 'preview' or 'success')",
  "output": "object? - Final output (when status is 'success')",
  "error": "object? - Error details (when status is 'failed')"
}