Skip to content

API Reference

Complete reference for all consumer-facing endpoints. These are the endpoints you call with your API key to execute engines, check results, and download files.

Base URL

https://api.xlsxapi.eu

Endpoints

Method Path Description
POST /jobs/execute/{tenant}/{engine} Execute the active version of an engine
GET /jobs/about/{tenant}/{engine} Get engine metadata and schemas
GET /jobs/{job_id} Get job status and results
GET /jobs/{job_id}/download Get download URL for the filled Excel file

Authentication

All requests require an API key via one of:

X-API-Key: your_api_key

Authorization: Bearer your_api_key

See Authentication for details.

Common Response Codes

Code Meaning
200 Success
202 Job accepted and queued for processing
400 Bad request (validation failed, no active version)
401 Invalid or missing API key
403 Insufficient permissions or IP not whitelisted
404 Tenant, engine, or job not found
429 Rate limited
500 Server error

All errors return:

{
  "detail": "Human-readable error message"
}

Rate Limits

Scope Limit
Per consumer API key 30 requests/minute (execution endpoints)
Per IP (job endpoints) 30 requests/minute
Per IP (general) 100 requests/minute

When rate-limited, the server returns 429 Too Many Requests.

Interactive Docs

The backend also serves interactive documentation: