Schemas

Crea un schema en la cuenta asociada al API key

Llama POST https://claix.dev/api/create-schema. Crea un schema listo para usar en los endpoints de extracción o Modo Agente. name, type y schema_definition son obligatorios. Si is_agent_mode es true (o se envía agent_definition), hay que incluir agent_definition con al menos un parámetro. El tipo json-excel no admite Modo Agente. Esta llamada es gratuita: no se factura ni consume el cupo de extracciones.

post/create-schema

Request

  • Base URL: https://claix.dev/api
  • URL: https://claix.dev/api/create-schema
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

namestring required

Nombre visible del schema.

type'excel-json' | 'json-excel' | 'pdf-json' | 'doc-json' | 'img-json' | 'txt-json' | 'audio-json' required

Tipo de conversión para el que se usará este schema.

schema_definitionobject required

Campos a extraer. Cada clave es el nombre de la propiedad JSON resultante; cada valor tiene type (string, integer, number o boolean) y description.

is_agent_modeboolean

Activa el Modo Agente. Si omites este campo pero envías agent_definition, se asume true.

agent_definitionobject

Obligatorio si is_agent_mode es true. Cada clave es el nombre del campo en agent_data. Types: boolean, string, closed, integer. Si type es closed, options es obligatorio.

resumen_agentstring nullable

Instrucción opcional para la fase de razonamiento.

window_contextboolean

Activa la ventana temporal de contexto. Por defecto false.

cita_por_campoboolean

Activa la verificación de fuente en las extracciones y en modo agente. Por defecto false. Si es true, cada campo de data y agent_data es { value, source }.

Example request

{
  "name": "DNI cliente",
  "type": "img-json",
  "is_agent_mode": true
}

Response

Schema creado correctamente

successboolean

Example response

{
  "success": true,
  "schema": {
    "id": "b980cfe7-61ef-4a5a-9724-881c8a5541e2",
    "name": "Facturas Trimestrales",
    "type": "pdf-json",
    "schema_definition": {
      "nif_cliente": {
        "type": "string",
        "description": "NIF o CIF del cliente facturado."
      }
    },
    "agent_definition": {
      "clausula_penalizacion": {
        "type": "boolean",
        "description": "Indica si el contrato incluye cláusula de penalización."
      }
    },
    "created_at": "2026-08-06T09:51:41.372964+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.