Image → Markdown
Imagen a Markdown
Endpoint
POST
https://claix.dev/api/img-markdownTranscribe el texto visible de la imagen a Markdown. Mismos formatos, firma binaria, límite de 15 MB y control de calidad que Imagen → JSON. La llamada al modelo y BYOK es la misma; la salida es Markdown, no un schema.
No hay schema_id. El Markdown siempre se devuelve. Con window_context=true se conserva durante el window_time que indiques y la respuesta incluye document_id. space_id es opcional y solo aplica cuando el documento se conserva: lo asocia a ese espacio de conocimiento.
1. Autenticación
La misma comprobación de API key que en los endpoints JSON. La key tiene que estar activa y la cuenta en estado active.
x-api-key: <TU_API_KEY>
O bien:
Authorization: Bearer <TU_API_KEY>
2. Parámetros
| Campo | Obligatorio | Descripción |
|---|---|---|
| file | Sí | Archivo multipart. .jpeg, .jpg, .png, .webp, .heic y .heif. Máximo 15 MB. |
| window_context | No | true conserva el Markdown y devuelve document_id. Si no viene, o es false, solo se devuelve el Markdown. |
| window_time | Obligatorio si window_context es true | Minutos: 5, 10, 15, 30, 45, 60, 90, 120, 180, 240, 360, 480, 720, 1440, o infinity. infinity exige el modo persistente activo en la cuenta. |
| space_id | No | UUID de un espacio de conocimiento del dueño de la API key. Solo si window_context es true. El documento conservado se asocia a ese espacio. |
Modelo: Sí. Si la imagen no es legible, la respuesta es 422.
3. Ejemplo
curl -X POST "https://claix.dev/api/img-markdown" \ -H "x-api-key: TU_API_KEY" \ -F "file=@factura.jpg" \ -F "window_context=true" \ -F "window_time=1440" \ -F "space_id=SPACE_UUID"
{
"success": true,
"markdown": "# Title\n\nBody...",
"document_id": "DOCUMENT_UUID",
"log_id": "LOG_UUID"
}4. Códigos de estado
| Código | Cuándo |
|---|---|
| 200 | Markdown producido. Se guarda solo si window_context es true. |
| 400 | Falta file o content, formato incorrecto, window_time inválido, space_id sin window_context, o infinity sin modo persistente. |
| 401 | API key ausente, inválida, inactiva o cuenta no activa. |
| 404 | space_id no existe en esta cuenta. |
| 405 | Método distinto de POST. |
| 413 | Archivo o texto por encima del mismo límite que el endpoint JSON. |
| 422 | PDF escaneado, imagen o audio rechazado por ilegible, o Markdown vacío. |
| 502 | Falló la llamada al modelo. |