XDOKU API
Genera guías paso a paso desde tu propio software.
Envía imágenes,
recibe documentación profesional.
$ curl -X POST https://api.xdoku.com/v1/guides \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"generation_type":"guide","images":[...]}'
✓ 201 Created — Guía generada en 2.4s con 8 pasos detectados
¿Para quién es la API?
Automatización empresarial
Integra la generación de documentación en tus flujos de trabajo existentes. Cada vez que tu equipo completa un proceso, genera la guía automáticamente.
Fabricantes de software
Integra la generación de documentación de procesos como funcionalidad nativa en tu producto. Tus usuarios generan documentación profesional sin salir de tu aplicación.
CI/CD y DevOps
Genera documentación actualizada de cada release automáticamente. Captura pantallas en tu pipeline y envíalas a la API para documentar cada versión.
Un endpoint. Documentación completa.
Envía un array de imágenes (capturas de pantalla de un proceso) y la IA de XDOKU analiza cada imagen, detecta los cambios entre ellas, y genera automáticamente una guía con títulos, descripciones y anotaciones.
Captura
Tu sistema captura screenshots del proceso
Envío
POST al endpoint con las imágenes en Base64 o URLs
Procesamiento IA
XDOKU analiza, anota y genera las descripciones
Resultado
Recibes la guía en JSON, PDF, DOCX o HTML
Endpoint principal
/v1/guidesGenera documentación paso a paso a partir de un conjunto ordenado de imágenes. El título y las descripciones de cada paso se generan automáticamente por IA.
Headers requeridos
| Header | Valor | Descripción |
|---|---|---|
Authorization |
Bearer YOUR_API_KEY |
Tu clave de API personal |
Content-Type |
application/json |
Tipo de contenido del body |
Cuerpo de la petición (JSON)
{
"generation_type": "guide",
"language": "es-ES",
"output_format": "json",
"images": [
{
"type": "base64",
"data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg...",
"filename": "paso_1_inicio.png"
},
{
"type": "base64",
"data": "data:image/png;base64,R0lGODlhPQBEAPeoAJos...",
"filename": "paso_2_formulario.png"
},
{
"type": "url",
"data": "https://storage.example.com/screenshots/step3.png"
}
],
"options": {
"detect_annotations": true,
"highlight_changes": true,
"annotation_style": "numbered_circles"
}
}Parámetros del body
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
generation_type |
string | Sí | guide o description. Determina el estilo de las
descripciones generadas |
language |
string | No | Idioma de salida para los títulos y descripciones generados (ISO 639-1). Default:
en-GB
|
output_format |
string | No | json | pdf | docx | html.
Default: json |
images |
array | Sí | Array ordenado de imágenes (mín. 2, máx. 50) |
images[].type |
string | Sí | base64 o url |
images[].data |
string | Sí | Data URI (base64) o URL pública de la imagen |
images[].filename |
string | No | Nombre descriptivo del archivo |
options |
object | No | Opciones avanzadas de procesamiento |
Respuesta (200 OK)
{
"id": "guide_a1b2c3d4e5",
"title": "Configuración del módulo de facturación",
"description": "Guía paso a paso para activar y configurar el módulo...",
"generation_type": "guide",
"created_at": "2026-02-15T04:30:00Z",
"steps": [
{
"index": 0,
"title": "Accede al panel de administración",
"description": "Haz clic en 'Configuración' en el menú de Windows...",
"image_url": "https://api.xdoku.com/v1/assets/guide_a1b2.../step_0.png",
"annotations": [
{ "type": "circle", "x": 845, "y": 32, "label": "1" }
]
}
],
"metadata": {
"total_steps": 8,
"processing_time_ms": 2400,
"images_processed": 3
}
}Códigos de error
| Código | Significado |
|---|---|
401 |
API Key inválida o no proporcionada |
400 |
Body malformado o imágenes inválidas |
413 |
Payload demasiado grande (máx. 50 MB por petición) |
429 |
Rate limit excedido |
500 |
Error interno del servidor |
Tipos de generación (generation_type)
El parámetro generation_type
determina el estilo de las descripciones que la IA genera para cada paso:
Guía instructiva
Genera instrucciones dirigidas al usuario, indicándole qué debe hacer en cada paso.
"description": "Haz clic en 'Configuración' en el menú de Windows para acceder a la configuración del sistema."Descripción neutra
Genera descripciones objetivas de lo que ocurre en cada captura, sin dirigirse al usuario.
"description": "Se abrió la 'Configuración' de Windows."Cómo enviar las imágenes
Base64 Data URI
Codifica cada imagen en Base64 e inclúyela directamente en el JSON. Ideal para automatización donde las imágenes se generan en memoria.
{
"type": "base64",
"data": "data:image/png;base64,iVBOR..."
}- ✓ No requiere hosting de imágenes
- ✓ Todo en una sola petición
- ✓ Formatos: PNG, JPG, WebP
- ⚠ Máximo 10 MB por imagen
URL pública
Proporciona URLs accesibles públicamente. XDOKU descargará las imágenes durante el procesamiento. Ideal para imágenes ya almacenadas en la nube.
{
"type": "url",
"data": "https://cdn.example.com/s3.png"
}- ✓ Payload más ligero
- ✓ Compatible con S3, GCS, Azure Blob
- ✓ URLs firmadas soportadas
- ⚠ La URL debe ser accesible por nuestros servidores
Pago por uso, sin compromisos
Cada llamada a la API genera una guía completa. El coste se calcula por petición procesada.
Prueba Gratis
Para pruebas y desarrollo
- 30 peticiones
- Output JSON
- Hasta 10 imágenes/guía
- Sandbox environment
Business
Para producción y equipos
- Peticiones ilimitadas
- Output JSON, PDF, DOCX, HTML
- Hasta 50 imágenes/guía
- Webhooks y callbacks
- Soporte prioritario
Enterprise
Para grandes volúmenes
- Volumen con descuento
- SLA garantizado 99.9%
- Instancia dedicada
- Personalización de branding
- Account manager dedicado
¿Listo para automatizar tu documentación?
Contacta con nuestro equipo para obtener tu API Key y empezar a generar guías programáticamente.
Contáctanos para más información