Getting Started¶
This guide walks you through making your first API call to an XLSX API engine. You'll need:
- An API key provided by your tenant administrator
- The tenant slug and engine slug for the engine you want to call
Quick Start¶
# 1. Check what inputs the engine expects
curl -H "X-API-Key: YOUR_API_KEY" \
https://api.xlsxapi.eu/jobs/about/TENANT_SLUG/ENGINE_SLUG
# 2. Execute the engine
curl -X POST https://api.xlsxapi.eu/jobs/execute/TENANT_SLUG/ENGINE_SLUG \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"inputs": {"customerAge": 35, "propertyValue": 500000}}'
# 3. Poll for results (replace JOB_ID with the job_id from step 2)
curl -H "X-API-Key: YOUR_API_KEY" \
https://api.xlsxapi.eu/jobs/JOB_ID
That's it. Three calls: discover, execute, retrieve.
Base URL¶
All API requests go to:
What's Next¶
- Authentication — how to pass your API key
- Your First API Call — step-by-step walkthrough
- API Reference — complete endpoint documentation