Schemas

Devuelve un schema concreto de la cuenta asociada al API key

Endpoint de solo lectura. Llama GET https://claix.dev/api/get-schema/{schema_id}. Dado un API key válido y un schema_id en la URL, devuelve ese schema con toda su información (id, nombre, tipo, definición, Modo Agente, ventana de contexto y verificación de fuente) si pertenece a la cuenta. Esta llamada es gratuita: no se factura ni consume el cupo de extracciones.

get/get-schema/{schema_id}

Request

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

Path parameters

schema_idstring uuid required
Example:b980cfe7-61ef-4a5a-9724-881c8a5541e2

UUID del schema a consultar

Response

Schema obtenido 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.