Agent mode API

Agent mode endpoints

Structured extraction plus semantic reasoning with agent_definition parameters.

Excel-to-JSON · Agent mode

Excel / CSV to JSON with Agent mode

Endpoint

POSThttps://www.claix.dev/agent/excel-json

Agent mode active

This endpoint runs structured extraction from the main schema first, then a reasoning phase with agent_definition. The response includes data[] (extraction) and agent_data (typed inference). The schema must have is_agent_mode enabled.

This 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

FieldTypeRequiredDescription
fileBinary fileYesExcel (.xlsx) or CSV (.csv). Must be the file itself, not a path or URL.
schema_idText (UUID)YesIdentifier 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

  1. Have your API key and the correct schema_id ready.
  2. Build a POST request to the endpoint URL.
  3. Add the authentication header.
  4. Send multipart/form-data with file and schema_id.
  5. 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": "Inventario Q3",
  "total_registros": 2,
  "data": [
    { "sku": "SKU-001", "stock": 120, "precio": 19.99 },
    { "sku": "SKU-002", "stock": 45, "precio": 34.5 }
  ],
  "agent_data": {
    "stock_critico": true,
    "productos_bajo_minimo": 1,
    "resumen_inventario": "Un producto por debajo del umbral mínimo de stock."
  }
}
FieldTypeDescription
successbooleanAlways true when HTTP is 200.
schema_utilizadostringName of the schema used for extraction.
total_registrosnumberNumber of records in data.
dataarrayObjects extracted from the main schema (same as extraction mode).
agent_dataobjectTyped Agent Mode answers per agent_definition (booleans, numbers, strings).

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

CodeCategoryRetry?
200Success
400Client error (malformed data)No — fix the request first
401Authentication errorNo — fix credentials first
404Resource not foundNo — fix schema_id first
405Incorrect HTTP methodNo — fix the method first
422No matches foundNo — review data/schema first
500Internal server errorYes, with caution
502AI service failureYes, 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_columnas for traceability during testing.
  • Do not include your API key in frontend code or public repositories.

Request examples

curl -X POST "https://www.claix.dev/agent/excel-json" \
  -H "x-api-key: <TU_API_KEY>" \
  -F "file=@./leads_octubre.xlsx" \
  -F "schema_id=8f14e45f-ceea-4e6f-8b23-1e2d3c4b5a6f"