मॉडल से ड्रॉइंग तक, HTTP पर

• एक Occlusia खाता और एक API कुंजी, जो आपके खाते में API कुंजियाँ के अंतर्गत बनती है। कुंजी को एक एनवायरनमेंट वेरिएबल में रखें: उदाहरण OCCLUSIA_API_KEY पढ़ते हैं।
• एक मॉडल: SketchUp 2021 या बाद के संस्करण में सहेजी गई .skp फ़ाइल, एक .ifc, एक .fbx या एक .occs फ़ाइल, अधिकतम 512 MB।
• आपका ग्राफ़िक मानक एक कॉन्फ़िगरेशन के रूप में, जो Occlusia Studio से Export › Configuration (.occc) के साथ एक्सपोर्ट किया गया हो — या कोई नहीं, और मॉडल डिफ़ॉल्ट सेटिंग से बनाया जाता है।
• क्रेडिट, या शुरुआती पहुँच का खाता: मॉडल खोलने और हर एक्सपोर्ट में क्रेडिट लगते हैं (API और MCP, इसकी लागत क्या है)।

1. 01

   सेशन खोलें

   POST /sessions आपका अपना इंजन शुरू करता है, आपके खाते में साइन इन, और उसका id लौटाता है। एक खाते में एक समय में 3 सेशन होते हैं; एक सेशन 15 मिनट उपयोग न होने पर, या 8 घंटे बाद समाप्त हो जाता है।

2. 02

   फ़ाइलें अपलोड करें

   PUT /sessions/{id}/files/{name}, फ़ाइल को रॉ बॉडी के रूप में भेजकर: मॉडल, और उसका कॉन्फ़िगरेशन। नाम सेशन में फ़ाइल का नाम है, सर्वर पर कोई पाथ नहीं।

3. 03

   खोलें और कॉन्फ़िगर करें

   model.open कमांड {"path": "house.skp"} के साथ मॉडल खोलता है और उसके व्यू sections में लौटाता है। {"path": "standard.occc"} के साथ config.set कॉन्फ़िगरेशन लागू करता है; फ़ॉर्मेट तोड़ने वाला कॉन्फ़िगरेशन पूरा अस्वीकार कर दिया जाता है, हर त्रुटि के साथ।

4. 04

   ज़रूरत हो तो देखें

   preview.render एक व्यू को PNG, JPEG या स्वयं SVG के रूप में लौटाता है, अपनी लंबी भुजा पर 2048 पिक्सल तक। एक्सपोर्ट को इसकी ज़रूरत नहीं।

5. 05

   एक्सपोर्ट

   export, एक format के साथ — svg, dxf, pdf, png या jpg —, बनाने के लिए sections — एक व्यू का नाम, या उनकी सूची — और out: एक ड्रॉइंग के लिए फ़ाइल, कई के लिए फ़ोल्डर। merged उनका एक PDF बनाता है।

6. 06

   डाउनलोड करें, फिर सेशन समाप्त करें

   GET /sessions/{id}/files/{name} वह डाउनलोड करता है जो एक्सपोर्ट ने लिखा; DELETE /sessions/{id} सेशन समाप्त करता है, और उसकी फ़ाइलें उसके साथ हटा दी जाती हैं।

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"

उदाहरण मॉडल का पहला व्यू एक्सपोर्ट करते हैं। sections.list सबकी सूची देता है और बताता है कि कौन-सा सक्रिय है; objects.list, annotations.list और levels.list मॉडल के बाकी हिस्से की सूची देते हैं।

• "sections": "Section A-A" एक व्यू एक्सपोर्ट करता है; ["Section A-A", "Ground floor plan"] कई, हर एक out फ़ोल्डर में अपनी फ़ाइल के रूप में — या "merged": true के साथ एक PDF।
• page हर व्यू का PDF पेज तय करता है — format, orientation, scale_mode fit या custom अपने scale_denominator (1:N), margins_mm के साथ —, pages एक बार में एक व्यू; image PNG या JPEG का आकार या स्केल, रेज़ोल्यूशन, बैकग्राउंड और क्वालिटी तय करता है।
• export.config हर व्यू का पेज सेटअप पढ़ता है, और export.setup उसे बिना एक्सपोर्ट किए बदलता है, जैसा एक्सपोर्ट डायलॉग करता है।
• एक्सपोर्ट उन फ़ाइलों को लौटाता है जो उसने लिखीं और उसकी लागत; GET /sessions/{id}/files सेशन की फ़ाइलों की सूची देता है।

कॉन्फ़िगरेशन में रहने वाली हर सेटिंग एक बार में एक कमांड से भी सेट की जा सकती है: ऑब्जेक्ट के लिए object.set, हैच प्रीसेट के लिए object.apply_preset, DXF लेयर के लिए layers.create और layers.update, व्यू के लिए section.set, नोट और स्पॉट एलिवेशन के लिए annotation.set और level.set। engine.schema हर सेटिंग और उसके मान की सूची देता है; config.get पूरा कॉन्फ़िगरेशन लौटाता है, जिसे .occc फ़ाइल के रूप में रखा जा सके।

PDF का सेट मिनटों ले सकता है। उसकी कमांड Prefer: respond-async के साथ भेजें: वह तुरंत 202 और एक जॉब लौटाती है, और GET /sessions/{id}/jobs/{job} बताता है कि जॉब चल रहा है, अपने परिणाम के साथ पूरा हुआ है, या अपनी त्रुटि के साथ विफल हुआ है। GET /sessions/{id}/events इंजन जो कर रहा है उसे सर्वर-सेंट इवेंट के रूप में स्ट्रीम करता है: progress, message, export, job, ended।

• हर अस्वीकृति {"error": {"code", "message"}} है, एक स्थिर कोड और उसके साथ जाने वाले HTTP स्टेटस के साथ।
• cloud_limit या rate_limited के साथ 429, और busy के साथ 503, Retry-After लिए होते हैं: उतनी देर प्रतीक्षा करें, फिर वही अनुरोध दोबारा भेजें।
• कमांड के साथ एक Idempotency-Key भेजें: उत्तर खो जाने के बाद पुनः प्रयास का उत्तर पहली बार के रन से दिया जाता है — न दोबारा चलता है, न दो बार शुल्क लगता है।
• हर उत्तर X-Request-Id लिए होता है: किसी अनुरोध के बारे में कोई भी प्रश्न पूछते समय इसे दें।

GET /v1/engine

इंजन का संस्करण और बिल्ड, बिना कुंजी के।

GET /v1/engine/openapi.json

पूरा API OpenAPI में।

GET /v1/engine/commands

हर कमांड, अपने पैरामीटर के साथ JSON Schema के रूप में।

हर रूट, सीमा और त्रुटि कोड API और MCP में, REST API के अंतर्गत सूचीबद्ध है।