> ## Documentation Index
> Fetch the complete documentation index at: https://docs.identifai.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Descarga un mapa XAI

> Descarga el **Attention Map** o el **Attention Graph** producido por el scope [XAI – eXplainable AI](/es/classification/classify-image#xai-explainable-ai) para un modelo, para una imagen enviada con `with_xai=true` o para un frame de un vídeo enviado con `with_xai=true` (usa el `identifier` del frame en `results.images`).

Los mapas producidos dependen del modelo: las `explanations` de los resultados por modelo indican el `type` y el `method` de cada mapa disponible para el modelo, también cuando no se solicitaron las explicaciones impulsadas por IA. La heatmap de la Smart Full Analysis no es un mapa XAI: descárgala con el [endpoint de la heatmap](./get-classification-heatmap).

**Nota:** este endpoint también está disponible con el alias `/api/classification_image/xai/{identifier}`.



## OpenAPI

````yaml es/api-reference/api-swagger-dev-documentation.json GET /api/classification/xai/{identifier}
openapi: 3.0.0
info:
  title: API de identifAI
  version: 1.0.0
  description: >-
    API para integrar las funcionalidades de clasificación de imágenes y vídeos
    de identifAI.<br><details><summary>**Cómo obtener tu API key**</summary>Para
    obtener tu API key, sigue estos sencillos pasos:   <ol><li><p>**Crea un
    perfil de usuario y accede a la plataforma**</p>Si todavía no tienes una
    cuenta, visita nuestra plataforma y crea un perfil de usuario. Después de
    completar el registro y verificar tu correo electrónico, accede con tus
    credenciales.</li><li><p>**Abre el menú de usuario**</p>Después de acceder,
    haz clic en tu nombre o en el icono de usuario en la esquina superior
    derecha de la pantalla.</li><li><p>**Selecciona la opción API key**</p>En el
    menú desplegable que aparece, selecciona la opción "Api-Key". Desde allí
    puedes ver o generar tu API key.</li></ol>¡Ya puedes usar tu API key con
    nuestra API!</details><details><summary>**Cómo usar la API**</summary>Para
    usar la API, realiza primero una solicitud **POST** para iniciar la
    clasificación. Después usa el ***identificador*** devuelto por la solicitud
    **POST** para obtener los resultados.

    <details>

    <summary>**1. Clasificación de imágenes**</summary>
      * Para clasificar una imagen, realiza una solicitud **POST** a `/api/classification` con los parámetros obligatorios (para más detalles sobre los parámetros, consulta la sección *"Clasificación"* más abajo).
      * En la respuesta recibirás el ***identificador*** de la imagen clasificada.
      * Usa el ***identificador*** recibido para obtener los resultados de la clasificación con una solicitud **GET** a `/api/classification/{identifier}` (para más detalles sobre cómo estructurar la solicitud, consulta la sección *"Clasificación"* más abajo).
      * La respuesta contiene los resultados de la clasificación de la imagen en formato JSON.<br>En la respuesta encontrarás un array ***results***, con los resultados de la clasificación de cada modelo usado, y un array ***verdicts***, con los resultados de cada heurística aplicada.<br>Si la clasificación aún no se ha completado, sigue enviando la solicitud **GET** hasta que el resultado esté disponible.</details><details><summary>**2. Clasificación de vídeos**</summary>
        * Para clasificar un vídeo, realiza una solicitud **POST** a `/api/classification_video` con los parámetros obligatorios (para más detalles sobre los parámetros, consulta la sección *"Clasificación"* más abajo).
        * En la respuesta recibirás el ***identificador*** del vídeo clasificado.
        * Usa el ***identificador*** recibido para obtener los resultados de la clasificación con una solicitud **GET** a `/api/classification_video/{identifier}` (para más detalles sobre cómo estructurar la solicitud, consulta la sección *"Clasificación"* más abajo).
        * La respuesta contiene los resultados de la clasificación del vídeo en formato JSON. Para la clasificación, el vídeo se divide en *frames*.<br> En la respuesta encontrarás un array ***results***, con el resultado de la clasificación de cada modelo aplicado a cada frame analizado, y un array ***verdicts***, con los resultados de cada heurística usada.<br> Si la clasificación no se ha completado, sigue enviando la solicitud **GET** hasta que se devuelvan los resultados finales.</details><details><summary>**3. Todas las clasificaciones**</summary>El endpoint `/api/classifications` devuelve todas las clasificaciones de imágenes realizadas por un usuario, con los resultados de todas las solicitudes de clasificación de imágenes anteriores.</details><details><summary>**4. Gestión de usuarios**</summary>  El endpoint **POST** `/api/user` permite crear un usuario, mientras que el endpoint **DELETE** `/api/user` sirve para eliminar un usuario (para la estructura de las solicitudes, consulta la sección de usuarios más abajo).</details></details>
servers:
  - url: https://backend.identifai.net
security: []
tags:
  - name: Classification
    description: Rutas de clasificación
  - name: Infrastructure
    description: Rutas de infraestructura
  - name: User
    description: Acciones del usuario
  - name: Partner
    description: Acciones de los partners
paths:
  /api/classification/xai/{identifier}:
    get:
      tags:
        - Classification
      summary: Descarga un mapa XAI
      description: >-
        Descarga el **Attention Map** o el **Attention Graph** producido por el
        scope [XAI – eXplainable
        AI](/es/classification/classify-image#xai-explainable-ai) para un
        modelo, para una imagen enviada con `with_xai=true` o para un frame de
        un vídeo enviado con `with_xai=true` (usa el `identifier` del frame en
        `results.images`).


        Los mapas producidos dependen del modelo: las `explanations` de los
        resultados por modelo indican el `type` y el `method` de cada mapa
        disponible para el modelo, también cuando no se solicitaron las
        explicaciones impulsadas por IA. La heatmap de la Smart Full Analysis no
        es un mapa XAI: descárgala con el [endpoint de la
        heatmap](./get-classification-heatmap).


        **Nota:** este endpoint también está disponible con el alias
        `/api/classification_image/xai/{identifier}`.
      parameters:
        - name: identifier
          in: path
          required: true
          schema:
            type: string
          description: El identificador de la imagen o del frame del vídeo.
        - name: model
          in: query
          required: true
          schema:
            type: string
          description: >-
            El nombre del modelo que produjo el mapa, tal como aparece en el
            campo `model` de los resultados por modelo (p. ej., `Revelio`).
        - name: method
          in: query
          required: true
          schema:
            type: string
            enum:
              - legrad
              - transformer_attribution
              - attention_rollout
          description: El método XAI usado para calcular el mapa.
        - name: type
          in: query
          required: false
          schema:
            type: string
            enum:
              - attention_map
              - attention_graph
            default: attention_map
          description: >-
            El mapa que se descarga: `attention_map` (superpuesto al contenido
            original) o `attention_graph` (tendencia y picos de la atención del
            modelo).
      responses:
        '200':
          description: El mapa XAI, como imagen.
          content:
            image/png:
              schema:
                type: string
                format: binary
        '400':
          description: Falta `model` o `method`, o el `type` no es válido.
          content:
            application/json:
              examples:
                missing_parameters:
                  summary: Faltan parámetros
                  value:
                    error: 'Missing required parameters: model, method'
                invalid_type:
                  summary: Tipo no válido
                  value:
                    error: >-
                      Invalid type parameter. Allowed values: attention_map,
                      attention_graph
        '401':
          description: API key no válida o ausente.
          content:
            application/json:
              example:
                error: Unauthorized
        '403':
          description: >-
            La imagen o el frame no existe o no tienes autorización para acceder
            a él.
          content:
            application/json:
              example:
                error: Unauthorized
        '404':
          description: >-
            No hay ningún mapa del modelo, el método y el tipo solicitados
            disponible para la imagen o el frame.
          content:
            application/json:
              example:
                error: Not found
        '429':
          description: Demasiadas solicitudes.
          content:
            application/json:
              example:
                error: Too Many Attempts.
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: Tu API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.