D’un modèle à un dessin, via HTTP

• Un compte Occlusia et une clé d’API, créée sous Clés d’API dans votre compte. Gardez la clé dans une variable d’environnement : les exemples lisent OCCLUSIA_API_KEY.
• Un modèle : un fichier .skp enregistré par SketchUp 2021 ou ultérieur, un fichier .ifc, .fbx ou .occs, 512 Mo au plus.
• Votre norme graphique sous forme de configuration, exportée depuis Occlusia Studio avec Export › Configuration (.occc) — ou aucune, et le modèle est dessiné avec les réglages par défaut.
• Des crédits, ou un compte en accès anticipé : l’ouverture du modèle et chaque export coûtent des crédits (API et MCP, Ce que cela coûte).

1. 01

   Ouvrir une session

   POST /sessions démarre un moteur à vous, connecté à votre compte, et répond son id. Un compte tient 3 sessions à la fois ; une session se termine après 15 minutes d’inactivité, ou après 8 heures.

2. 02

   Envoyer les fichiers

   PUT /sessions/{id}/files/{name}, avec le fichier comme corps brut : le modèle, et sa configuration. Un nom est le nom du fichier dans la session, jamais un chemin sur le serveur.

3. 03

   Ouvrir et configurer

   La commande model.open avec {"path": "house.skp"} ouvre le modèle et répond ses vues, dans sections. config.set avec {"path": "standard.occc"} applique la configuration ; une configuration qui enfreint le format est refusée en bloc, avec toutes ses erreurs.

4. 04

   Regarder, si besoin

   preview.render répond une vue sous forme de PNG, de JPEG ou du SVG lui-même, jusqu’à 2048 pixels sur son plus grand côté. Un export n’en a pas besoin.

5. 05

   Exportez

   export avec un format — svg, dxf, pdf, png ou jpg —, les sections à dessiner — le nom d’une vue, ou une liste de noms — et out : un fichier pour un dessin, un dossier pour plusieurs. merged en fait un seul PDF.

6. 06

   Télécharger, puis terminer la session

   GET /sessions/{id}/files/{name} télécharge ce que l’export a écrit ; DELETE /sessions/{id} termine la session, et ses fichiers sont supprimés avec elle.

KEY=occ_sk_…                                  # Account › API keys
API=https://api.occlusia.app/v1/engine
AUTH="Authorization: Bearer $KEY"
JSON="Content-Type: application/json"

# 1. A session: an engine of your own, with its own files
S=$(curl -s -X POST $API/sessions -H "$AUTH" | jq -r .id)

# 2. The model and your graphic standard
curl -T house.skp $API/sessions/$S/files/house.skp -H "$AUTH"
curl -T standard.occc $API/sessions/$S/files/standard.occc -H "$AUTH"

# 3. Open the model (1 credit), apply the configuration (free)
curl $API/sessions/$S/commands/model.open -H "$AUTH" -H "$JSON" -d '{"path":"house.skp"}'
curl $API/sessions/$S/commands/config.set -H "$AUTH" -H "$JSON" -d '{"path":"standard.occc"}'

# 4. Export one view as DXF (1 credit per drawing)
curl $API/sessions/$S/commands/export -H "$AUTH" -H "$JSON" \
     -d '{"format":"dxf","sections":"Section A-A","out":"section-a.dxf"}'

# 5. Download it, then end the session: its files are deleted with it
curl -o section-a.dxf $API/sessions/$S/files/section-a.dxf -H "$AUTH"
curl -X DELETE $API/sessions/$S -H "$AUTH"

Les exemples exportent la première vue du modèle. sections.list les liste toutes et dit laquelle est active ; objects.list, annotations.list et levels.list listent le reste du modèle.

• "sections": "Section A-A" exporte une vue ; ["Section A-A", "Ground floor plan"] plusieurs, chacune dans son propre fichier du dossier out — ou un seul PDF avec "merged": true.
• page règle la page PDF de chaque vue — format, orientation, scale_mode fit ou custom avec son scale_denominator (1:N), margins_mm —, pages une vue à la fois ; image règle la taille ou l’échelle, la résolution, le fond et la qualité d’un PNG ou d’un JPEG.
• export.config lit la mise en page de chaque vue, et export.setup la modifie sans exporter, comme le fait la boîte de dialogue d’export.
• Un export répond les fichiers qu’il a écrits et ce qu’il a coûté ; GET /sessions/{id}/files liste les fichiers de la session.

Chaque réglage que contient une configuration peut aussi être fait une commande à la fois : object.set pour un objet, object.apply_preset pour un préréglage de hachure, layers.create et layers.update pour les calques DXF, section.set pour une vue, annotation.set et level.set pour les notes et les cotes de niveau. engine.schema liste chaque réglage et ses valeurs ; config.get répond la configuration entière, à conserver comme fichier .occc.

Un jeu de PDF peut prendre des minutes. Envoyez sa commande avec Prefer: respond-async : elle répond aussitôt 202 et une tâche, et GET /sessions/{id}/jobs/{job} dit si la tâche est en cours, terminée avec son résultat, ou en échec avec son erreur. GET /sessions/{id}/events diffuse ce que fait le moteur en événements envoyés par le serveur : progress, message, export, job, ended.

• Chaque refus est de la forme {"error": {"code", "message"}}, avec un code stable et le statut HTTP qui l’accompagne.
• 429 avec cloud_limit ou rate_limited, et 503 avec busy, portent Retry-After : attendez ce délai, puis renvoyez la même requête.
• Envoyez une Idempotency-Key avec une commande : une nouvelle tentative après une réponse perdue reçoit la réponse de la première exécution — jamais exécutée ni facturée deux fois.
• Chaque réponse porte X-Request-Id : donnez-le avec toute question sur une requête.

GET /v1/engine

La version et le build du moteur, sans clé.

GET /v1/engine/openapi.json

Toute l’API en OpenAPI.

GET /v1/engine/commands

Chaque commande, avec ses paramètres en JSON Schema.

Chaque route, limite et code d’erreur est listé dans API et MCP, sous L’API REST.