Automation

Open API documentation

Use an API key to submit CAD drawings, inspect quota, and track tasks or batches.

Authentication and security

Every open endpoint uses an Authorization: Bearer header. Keys appear only when created or rotated. Use least privilege, CIDR allowlists, separate keys, and webhook signature verification.

Rate and concurrency headers are returned. Honor Retry-After after a 429 response.

Upload policy

JPEG, PNG, WebP, GIF, BMP, and PDF are accepted up to 20MB per file; PDFs may contain up to 10 pages. Successful tasks publish sanitized previews and summaries by default, never source files.

Endpoints and scopes

Open API endpoints and required scopes
Method	Path	Scope
GET	`/api/open/status`	status:read
GET	`/api/open/quota`	quota:read
GET	`/api/open/tasks`	tasks:read
POST	`/api/open/tasks`	tasks:create
GET	`/api/open/tasks/{task_id}`	tasks:read
POST	`/api/open/tasks/{task_id}/cancel`	tasks:create
POST	`/api/open/batches`	batches:create
GET	`/api/open/batches/{batch_id}`	batches:read

Submission example

curl -X POST "https://YOUR-CAD-DOMAIN/api/open/tasks" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "[email protected]" \
  -F "profile=standard" \
  -F "options_json={}"

profile may be standard, full, bom, dimension_tolerance, or advanced. Advanced mode selects modules through options_json.task_list.

Webhook

Subscribe to task.completed, task.failed, and task.cancelled. Verify signatures with the secret shown on creation or rotation, and deduplicate by event ID.