Excel-to-JSON
Excel / CSV to JSON conversion
Endpoint
https://www.claix.dev/api/excel-jsonThis endpoint accepts a tabular file (.xlsx or .csv) and returns it transformed into JSON with the exact structure you define via a schema. The file columns do not need to match schema property names literally: the system automatically recognizes synonyms, abbreviations, translations, and variants.
It is intended for server-to-serverintegrations (backends, scripts, n8n/Zapier/Make). It must not be called from an end user's browser because it requires a secret API key.
1. Authentication
Every request must include your API key. It is a personal server credential, distinct from any session token, and should be handled with the same care as a database password.
Option A — Dedicated header (recommended):
x-api-key: <YOUR_API_KEY>
Option B — Standard Authorization header:
Authorization: Bearer <YOUR_API_KEY>
Either one is sufficient. If you send both, x-api-key takes priority.
Before processing the file, the system validates that:
- The API key exists and is active.
- The associated account is active (not suspended).
If validation fails, the request is rejected with 401 without processing the file.
2. Request format
| Field | Type | Required | Description |
|---|---|---|---|
| file | Binary file | Yes | Excel (.xlsx) or CSV (.csv). Must be the file itself, not a path or URL. |
| schema_id | Text (UUID) | Yes | Identifier of the excel-json schema created in your account. |
Method: POST · Content-Type: multipart/form-data
Field names must be exactly file and schema_id. The schema must be of the Excel → JSON type; if you send one of the opposite type, you will receive 400.
File requirements:
- Formats: .xlsx, .csv.
- At least one header row and one data row.
- If there are multiple sheets, only the first is processed.
3. How to build the request
- Have your API key and the correct schema_id ready.
- Build a POST request to the endpoint URL.
- Add the authentication header.
- Send
multipart/form-datawithfileandschema_id. - Check the HTTP status code: only 200 indicates success.
4. Request examples
See the panel on the right for examples in cURL, JavaScript, Node.js, Python, PHP, and n8n. You can switch languages with the selector at the top and copy the code directly.
5. Successful response format
200 OK · Content-Type: application/json
{
"success": true,
"schema_utilizado": "Leads de Ventas",
"total_filas_procesadas": 247,
"mapa_columnas": {
"Nom_cliente": "nombre_completo",
"Tlf": "telefono_movil",
"mail de contacto": "email_contacto"
},
"data": [
{
"nombre_completo": "Ana María Gómez",
"cargo": "CEO & Founder",
"empresa": "TechSolutions",
"email_contacto": "ana.gomez@techsolutions.com",
"telefono_movil": "+1 (555) 019-2231"
}
]
}| Field | Type | Description |
|---|---|---|
| success | boolean | Always true when HTTP is 200. |
| schema_utilizado | string | Name of the applied schema (not the id). |
| total_filas_procesadas | number | Rows transformed in data (empty rows not counted). |
| mapa_columnas | object | Mapping of original column → schema property. |
| data | array | Records with keys matching the schema properties. |
6. Error codes
{
"error": "Descripción legible del problema.",
"detalle": "Información técnica adicional (solo presente en algunos casos)."
}400 — Invalid request: missing file or schema_id, incorrect multipart, corrupt file, no data rows, or schema of the wrong type.
401 — Authentication failed: key missing, nonexistent, deactivated, or account suspended.
404 — schema_id does not exist or does not belong to your account.
422 — File read but no matches with the schema.
502 — AI service failure (transient; retry with backoff).
405 — Method other than POST. · 500 — Internal error.
7. Code summary
| Code | Category | Retry? |
|---|---|---|
| 200 | Success | — |
| 400 | Client error (malformed data) | No — fix the request first |
| 401 | Authentication error | No — fix credentials first |
| 404 | Resource not found | No — fix schema_id first |
| 405 | Incorrect HTTP method | No — fix the method first |
| 422 | No matches found | No — review data/schema first |
| 500 | Internal server error | Yes, with caution |
| 502 | AI service failure | Yes, recommended with backoff |
8. Best practices
- Validate the HTTP status code before reading data.
- Only columns with a real match in the schema appear.
- Retry automatically only on 500 and 502, never on 4xx unless the request changes.
- Save
mapa_columnasfor traceability during testing. - Do not include your API key in frontend code or public repositories.