REST API

XDOKU API

Genera guías paso a paso desde tu propio software.
Envía imágenes, recibe documentación profesional.

Terminal

$ 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 — Guide generated in 2.4s with 8 steps detected

Use Cases

Who is the API for?

Enterprise automation

Integrate documentation generation into your existing workflows. Every time your team completes a process, automatically generate the guide.

Software manufacturers

Integrate process documentation generation as a native feature in your product. Your users generate professional documentation without leaving your application.

CI/CD y DevOps

Auto-generate updated documentation for each release. Capture screens in your pipeline and send them to the API to document each version.

How it works

One endpoint. Complete documentation.

Send an array of images (process screenshots) and XDOKU AI will analyze each image, detect changes between them, and automatically generate a guide with titles, descriptions and annotations.

Capture

Your system captures screenshots of the process

→

Send

POST to the endpoint with the images in Base64 or URLs

→

AI Processing

XDOKU analyzes, annotates and generates descriptions

→

Result

You receive the guide in JSON, PDF, DOCX or HTML

Technical Reference

Main Endpoint

POST /v1/guides

Generates step-by-step documentation from an ordered set of images. The title and descriptions of each step are generated automatically using AI.

Required Headers

Header	Value	Description
`Authorization`	`Bearer YOUR_API_KEY`	Your personal API key
`Content-Type`	`application/json`	Body content type

Request Body (JSON)

request.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	Description
`generation_type`	string	Sí	`guide` o `description`. Determina el estilo de las descripciones generadas
`language`	string	No	Output language for generated titles and descriptions (ISO 639-1). Default: `en-GB`
`output_format`	string	No	`json` \| `pdf` \| `docx` \| `html`. Default: `json`
`images`	array	Sí	Ordered array of images (min. 2, max. 50)
`images[].type`	string	Sí	`base64` o `url`
`images[].data`	string	Sí	Data URI (base64) or public image URL
`images[].filename`	string	No	Nombre descriptivo del archivo
`options`	object	No	Advanced processing options

Respuesta (200 OK)

response.json

{
  "id": "guide_a1b2c3d4e5",
  "title": "Billing module configuration",
  "description": "Step-by-step guide to activate and configure the module...",
  "generation_type": "guide",
  "created_at": "2026-02-15T04:30:00Z",
  "steps": [
    {
      "index": 0,
      "title": "Access the administration panel",
      "description": "Click on \'Settings\' in the Windows menu...",
      "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
  }
}

Error Codes

Code	Meaning
`401`	Invalid or missing API Key
`400`	Malformed body or invalid images
`413`	Payload too large (max. 50 MB per request)
`429`	Rate limit exceeded
`500`	Internal server error

Generation Types (`generation_type`)

The generation_type parameter determines the style of the descriptions the AI generates for each step:

guide

Instructional guide

Generates instructions directed at the user, indicating what they should do in each step.

"description": "Click on \'Settings\' in the Windows menu to access system settings."

description

Neutral description

Generates objective descriptions of what happens in each capture, without directly addressing the user.

"description": "The Windows \'Settings\' was opened."

Image Formats

How to provide images

Option A

Base64 Data URI

Encode each image in Base64 and include it directly in the JSON. Ideal for automation where images are generated in memory.

{
  "type": "base64",
  "data": "data:image/png;base64,iVBOR..."
}

✓ No image hosting required
✓ Everything in a single request
✓ Formats: PNG, JPG, WebP
⚠ Maximum 10 MB per image

Option B

URL pública

Provide publicly accessible URLs. XDOKU will download the images during processing. Ideal for images already stored in the cloud.

{
  "type": "url",
  "data": "https://cdn.example.com/s3.png"
}

✓ Lighter payload
✓ Compatible with S3, GCS, Azure Blob
✓ Signed URLs supported
⚠ The URL must be accessible by our servers

Pricing

Pay as you go, with no commitments

Each API call generates a complete guide. The cost is calculated per processed request.

Free Trial

For testing and development

€0

30 requests
Output JSON
Up to 10 images/guide
Sandbox environment

Start for free

Business

For production and teams

€0,30/request

Unlimited requests
Output JSON, PDF, DOCX, HTML
Up to 50 images/guide
Webhooks y callbacks
Priority support

Contact sales

Enterprise

For large volumes

Custom pricing

Volume discounts
99.9% SLA guaranteed
Dedicated instance
Branding customization
Dedicated account manager

Let\'s talk

Ready to automate your documentation?

Contact our team to get your API Key and start generating guides programmatically.