API V1

Schematic rendering API

Authenticate uploads with X-API-Key. Native binary OLE and ASCII SchDoc format 5.0 are accepted. Files are parsed asynchronously; HTTP 202 confirms admission, not rendering fidelity.

Upload

POST /api/v1/schematics/render

Multipart fields: file (required), access (private or unlisted; defaults to private), expires_in (optional seconds, bounded by server policy).

Poll

GET /api/v1/schematics/{id}/status

States: queued, processing, completed, failed. Private reads require X-Viewer-Token from the upload response, or the service API key. Completed responses include compatibility and diagnostics.

Retrieve

GET /api/v1/schematics/{id}/data returns the versioned structured document. GET /api/v1/schematics/{id}/svg returns the generated vector drawing.

View

Open the exact viewer_url from the upload response. The private token is in its fragment. It is stored for this browser tab and sent only as a request header. The viewer has no panels or toolbar.

Errors

JSON errors include success: false and error.code / error.message. Common HTTP codes: 401 invalid service key; 404 missing or inaccessible schematic; 409 still processing; 410 expired; 413 too large; 415 wrong extension; 422 invalid schematic; 503 storage unavailable or queue full.

Download OpenAPI schema ยท Upload a schematic