Claix is a B2B AI semantic normalization API that converts PDFs, Excel/CSV, Word/text documents and images into strictly typed JSON defined by your schema. Official site: https://www.claix.dev/en

What file formats does the Claix API support?

Claix supports Excel (.xlsx) and CSV, JSON to Excel export, PDF (text or scanned), .docx/.txt/.md/.rtf documents, and .jpeg/.jpg/.png/.webp/.heic/.heif images. Each format uses a dedicated endpoint and schema type.

How do I convert a PDF to JSON with Claix?

Create a pdf-json schema, obtain an API key, and send a multipart POST to https://www.claix.dev/api/pdf-json with file and schema_id fields and the x-api-key header. Documentation: https://www.claix.dev/en/documentation/pdf-to-json

What is Claix pricing?

Pay-as-you-go. The first 15 successful calls (HTTP 200) are free. Excel↔JSON is billed by variable volume (€0.25–€1.00). PDF→JSON €0.35, Doc→JSON €0.20, Img→JSON €0.10 per successful request. 4xx/5xx errors are not billed.

Does Claix offer an embeddable widget?

Yes. Claix provides a free unlimited iframe widget (https://www.claix.dev/widget/{id}), customizable and production-ready. JSON is delivered to the owner's HTTPS webhook; the API key is never exposed in the browser.

Where is the OpenAPI specification?

The OpenAPI 3 spec is at https://www.claix.dev/openapi.yaml. AI context summary: https://www.claix.dev/llms.txt and full knowledge base: https://www.claix.dev/llms-full.txt

Is Claix compatible with n8n and Make?

Yes. Use generic HTTP multipart or the n8n-nodes-claix community node. Guide: https://www.claix.dev/en/blog/integrar-claix-en-n8n

Is Claix GDPR compliant?

Claix offers EU-oriented processing, a public DPA at https://www.claix.dev/en/dpa, zero file retention for model training, and no training on customer documents.

Schemas · Create

Create a schema via API

Endpoint

POSThttps://www.claix.dev/api/create-schema

Creates a schema on the API key account, ready for extraction or Agent mode endpoints. It matches dashboard creation, with type and definition validation.

Always call https://www.claix.dev/api/create-schema. Do not use the internal Supabase URL (https://yuhcusjiywsuzjwirarw.supabase.co/functions/v1/create-schema).

Intended for server-to-server integrations. It is not billed (no usage_logs row).

1. Authentication

Every request must include your API key. It is a personal server credential, distinct from any session token.

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.

The system checks that the key exists, is active, and the account is not suspended. Failure returns 401.

2. Request format

Method: POST · Content-Type: application/json

Field	Type	Required	Description
name	string	Yes	Visible schema name (max 200).
type	string	Yes	excel-json, json-excel, pdf-json, doc-json, or img-json.
schema_definition	object	Yes	Fields to extract. Each key is the output JSON name.
is_agent_mode	boolean	No	Enables Agent mode. If omitted but agent_definition is sent, it is assumed true.
agent_definition	object	If agent mode	Reasoning parameters. Required when is_agent_mode is true.
resumen_agent	string	No	Extra instruction for the agent phase (max 500).

Each schema_definition field must look like:

{
  "nombre_dni": {
    "type": "string",
    "description": "full name printed on the ID card"
  }
}

Extraction types: string, integer, number, boolean. description is required.

Each agent_definition parameter uses boolean, string, closed, or integer. If type is closed, options must be a non-empty array:

{
  "calidad_foto": {
    "type": "closed",
    "options": ["buena calidad", "mala calidad", "ilegible", "perfecta"],
    "description": "Image quality and data legibility"
  }
}

The json-excel type does not support Agent mode.

3. How to build the call

Have your API key ready.
Send a JSON POST to https://www.claix.dev/api/create-schema.
Include name, type, and schema_definition.
For Agent mode, add is_agent_mode: true and agent_definition.
Check the HTTP status: 201 means it was created.

4. Request examples

Use the panel on the right for cURL, JavaScript, Node.js, Python, PHP, and n8n examples.

5. Successful response

201 Created · Content-Type: application/json

{
  "success": true,
  "schema": {
    "id": "b980cfe7-61ef-4a5a-9724-881c8a5541e2",
    "name": "DNI cliente",
    "type": "img-json",
    "schema_definition": {
      "nombre_dni": {
        "type": "string",
        "description": "nombre de la persona del dni"
      },
      "numero_dni": {
        "type": "string",
        "description": "numero de dni"
      },
      "fecha_caducidad": {
        "type": "string",
        "description": "fecha de caducidad del dni"
      }
    },
    "is_agent_mode": true,
    "agent_definition": {
      "edad": {
        "type": "integer",
        "description": "Edad exacta de la persona pero restale 3"
      },
      "calidad_foto": {
        "type": "closed",
        "options": ["buena calidad", "mala calidad", "ilegible", "perfecta"],
        "description": "La calidad de la imagen y la legibilidad de sus datos"
      },
      "es_mayor_edad": {
        "type": "boolean",
        "description": "Es mayor de edad actualmente la persona del dni?"
      },
      "fecha_vencimiento": {
        "type": "string",
        "description": "Cuado le vence el dni y cuanto tiempo queda para ello"
      }
    },
    "resumen_agent": null,
    "created_at": "2026-08-17T13:10:00.000Z"
  }
}

Field	Type	Description
success	boolean	Always true when HTTP is 201.
schema	object	Persisted schema, including its UUID.
schema.id	uuid	Use later as schema_id for extraction.
schema.schema_definition	object	Normalized definition.
schema.agent_definition	object \| null	Null when is_agent_mode is false.

6. Error codes

{
  "error": "Descripción legible del problema.",
  "detalle": "Información técnica adicional (solo presente en algunos casos)."
}

400 — Invalid payload: missing name/type/definition, unknown type, empty description, closed without options, or json-excel with Agent mode.

401 — Authentication failed: missing, unknown, or disabled key, or suspended account.

405 — Method other than POST. · 500 — Internal error.

7. Status code summary

Code	Category	Retry?
201	Created	—
400	Client error (malformed data)	No — fix the request first
401	Authentication error	No — fix credentials first
405	Incorrect HTTP method	No — fix the method first
500	Internal server error	Yes, with caution

8. Best practices

Use https://www.claix.dev/api/create-schema, never the Supabase URL.
type must match the extraction endpoint you will call later.
Clear descriptions improve AI accuracy for extraction and agent reasoning.
Never put your API key in frontend code or public repos.