Volver al inicio

Documentación de la API del Generador de Texto Alternativo con IA - Genere Automáticamente Texto Alternativo para Imágenes

Descripción General

La API del Generador de Texto Alternativo con IA es un potente servicio diseñado para generar automáticamente texto alternativo descriptivo para imágenes. Aprovechando una IA avanzada, esta API analiza sus imágenes y crea texto alternativo significativo y contextualmente relevante, lo cual es crucial para la accesibilidad y el SEO. Usar un generador de texto alternativo para imágenes como este ayuda a garantizar que su contenido visual sea comprensible para los motores de búsqueda. También le ahorra horas de trabajo manual y aumenta su productividad.

Escenarios de Aplicación

La API del Generador de Texto Alternativo con IA es ideal para una variedad de aplicaciones donde generar texto alternativo para imágenes es esencial:

Claves de API

Para acceder a la API del Generador de Texto Alternativo con IA, primero debe obtener una clave de API válida. Esta clave se utiliza para autenticar sus solicitudes y garantizar un acceso seguro a la API.

Cómo Obtener una Clave de API

  1. Acceda a la Página de Gestión de Claves de API: Inicie sesión en el sistema, luego haga clic en su avatar de usuario en la esquina superior derecha. En el menú desplegable, haga clic en "Solicitar API" para abrir la Página de Gestión de Claves de API.
API para el Generador de Texto Alternativo con IA
  1. Crear una Nueva Clave: Haga clic en "Crear Nueva Clave", ingrese un nombre para su clave en el cuadro de diálogo emergente y luego haga clic en "Crear".
Claves de API para el Generador de Texto Alternativo con IA
  1. Copie y Guarde Su Clave: Tenga en cuenta que la clave solo se mostrará en su totalidad una vez. Haga clic en el icono de copiar para copiar la clave a su portapapeles y luego haga clic en "Confirmar" para cerrar el cuadro de diálogo.

Importante: No la comparta con otros ni la exponga en el navegador, en el código del lado del cliente o en cualquier otro lugar inseguro. Mantenga su clave segura para evitar accesos no autorizados.

Endpoint de la API

POST https://api.imagedescriber.app/api/v1/generate_alt_text

Parámetros de la Solicitud

Encabezados de la Solicitud

EncabezadoTipoRequeridoDescripción
content-typestring`application/json`
authorizationstring`Bearer ${api_key}`, donde `${api_key}` es su clave de API.

Cuerpo de la Solicitud

La API del Generador de Texto Alternativo con IA acepta la siguiente estructura de solicitud:

{
  "image": "data:image/jpeg;base64,{image_base64_data}",
  "lang": "es"
}
ParámetroTipoRequeridoDescripción
imagestring

Los datos de la imagen codificados en Base64. Los formatos de imagen admitidos se enumeran en Detalles del Formato de Imagen.

langstringNoEl código de idioma para el texto alternativo devuelto. El valor predeterminado es `en` (Inglés). Los códigos de idioma admitidos se enumeran a continuación.

Idiomas Admitidos

CódigoIdioma
enInglés (Predeterminado)
deAlemán
zhChino
frFrancés
esEspañol
jaJaponés
koCoreano
itItaliano
ptPortugués
arÁrabe
nlHolandés
plPolaco

Ejemplo de Solicitud (cURL)

curl --location 'https://api.imagedescriber.app/api/v1/generate_alt_text' \
--header 'content-type: application/json' \
--header 'authorization: Bearer su_clave_de_api' \
--data '{
    "image":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQE...",
    "lang":"es"
}'

Ejemplo de Solicitud (Python)

import requests
import base64

def image_to_base64(image_path):
    """Convierte una imagen a codificación Base64"""
    with open(image_path, "rb") as image_file:
        encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
    return encoded_string

def generate_alt_text(api_key, image_path, lang="es"):
    """Genera texto alternativo para una imagen usando la API del Generador de Texto Alternativo con IA"""
    url = "https://api.imagedescriber.app/api/v1/generate_alt_text"
    headers = {
        "content-type": "application/json",
        "authorization": f"Bearer {api_key}"
    }

    image_base64_data = image_to_base64(image_path)
    payload = {
        "image": f"data:image/jpeg;base64,{image_base64_data}",
        "lang": lang
    }

    response = requests.post(url, headers=headers, json=payload)

    if response.status_code == 200:
        result = response.json()
        alt_text_data = result["data"]["alt_text"]
        print("Descripción Generada:", alt_text_data["description"])
        print("Textos Alternativos Generados:", alt_text_data["alt"])
        print("Créditos Restantes:", result["data"]["credits"]["remaining"])
    else:
        print(f"Error: {response.status_code}")
        print(response.text)

# Ejemplo de uso
api_key = "su_clave_de_api"
image_path = "su_imagen.jpg"

generate_alt_text(api_key, image_path)

Ejemplo de Solicitud (Next.js)

import fs from 'fs';

// Implementación del lado del servidor
const buffer = await fs.readFileSync("/temp/test.jpg");
const base64Image = buffer.toString('base64');
const imageData = `data:image/jpeg;base64,${base64Image}`;

// Implementación del lado del cliente
const file: File = /* archivo de un input o evento de soltar */;
const arrayBuffer = await file.arrayBuffer();
const bytes = new Uint8Array(arrayBuffer);
const base64Image = btoa(String.fromCharCode.apply(null, bytes as any));
const imageData = `data:${file.type};base64,${base64Image}`;

const body = {
  "image": imageData,
  "lang": "es"
};

const response = await fetch('https://api.imagedescriber.app/api/v1/generate_alt_text', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {su_clave_de_api}'
  },
  body: JSON.stringify(body),
});

const result = await response.json();
console.log('Descripción Generada:', result.data.alt_text.description);
console.log('Textos Alternativos Generados:', result.data.alt_text.alt);

Respuesta

Cuerpo de la Respuesta (Respuesta JSON)

El generador de texto alternativo para imágenes devuelve una respuesta que contiene una descripción detallada y un arreglo de opciones de texto alternativo.

{
  "code": 0,
  "message": "success",
  "request_id": "unique_request_id_string",
  "data": {
    "alt_text": {
      "description": "Descripción detallada de la imagen",
      "alt": [
        "alt1",
        "alt2",
        "..."
      ]
    },
    "credits": {
      "amount": "créditos consumidos por esta llamada",
      "remaining": "créditos totales restantes después de esta llamada"
    }
  }
}
CampoTipoDescripción
codenumberCódigo de estado, `0` indica éxito, un valor distinto de `0` indica un error.
messagestringMensaje de estado, describe el estado de la solicitud.
request_idstringID de solicitud único, utilizado para seguimiento y resolución de problemas.
dataobjectContiene los datos de la respuesta.
data.alt_textobjectContiene la descripción y el texto alternativo generados.
data.alt_text.descriptionstringUna descripción detallada del contenido de la imagen.
data.alt_text.altarrayUn arreglo de cadenas de texto alternativo generadas para la imagen.
data.creditsobjectInformación sobre el consumo de créditos y el saldo restante.
data.credits.amountnumberNúmero de créditos consumidos por esta llamada a la API.
data.credits.remainingnumberCréditos totales restantes en su cuenta después de esta llamada.

Límites de Solicitud

Para garantizar la estabilidad y equidad del servicio, cada clave de API está limitada a 30 solicitudes por minuto (1800 solicitudes por hora). Las solicitudes que excedan este límite serán rechazadas con el código de error 1004.

Sistema de Créditos

¿Cómo obtener más créditos?

Puede visitar la Página de Recarga de Créditos para comprar paquetes de créditos y realizar más llamadas a la API. Ofrecemos varios paquetes para satisfacer las necesidades de diferentes usuarios.

Manejo de Errores

La siguiente tabla enumera los códigos de error comunes, sus significados y soluciones:

Código de ErrorDescripciónSolución
1002No autorizadoVerifique que su encabezado `authorization` esté configurado correctamente.
1003Clave de API no válidaVerifique que su clave de API sea correcta u obtenga una nueva.
1004Demasiadas solicitudesReduzca la frecuencia de sus solicitudes, máximo 30 solicitudes por minuto.
1005Parámetros no válidosVerifique que los parámetros de su solicitud cumplan con las especificaciones.
2002Créditos insuficientes
2003Contenido bloqueado por el filtroModifique su imagen para asegurarse de que el contenido cumpla con las regulaciones.
2004Formato de imagen no válido

Utilice un formato de imagen admitido, consulte Detalles del Formato de Imagen.

2005Fallo en la carga de la imagenVerifique que los datos de su imagen sean válidos o intente cargarlos de nuevo más tarde.
2006No se pudo analizar la respuesta de la IA en el formato JSON esperado.
5050Error interno del servidorContacte a nuestro equipo de soporte técnico y proporcione el `request_id`.

Detalles del Formato de Imagen

Los formatos de imagen actualmente admitidos incluyen: JPG, JPEG, PNG, WebP. El tamaño máximo de la imagen es de 4MB.

Mejores Prácticas para Generar Texto Alternativo

  • Alta Resolución: Use imágenes claras y de alta resolución para un generador de texto alternativo para imágenes más preciso.
  • Buena Iluminación: Las imágenes bien iluminadas producen un texto alternativo más preciso y descriptivo.
  • Sujeto Claro: Las imágenes con sujetos y objetos definidos generan un texto alternativo más relevante.
  • Formatos Admitidos: Utilice los formatos admitidos (JPG, PNG, WebP) para obtener resultados óptimos.

Casos de Uso y Ejemplos de Integración

Mejora de SEO

Use la API del Generador de Texto Alternativo con IA para generar automáticamente texto alternativo para las imágenes en su sitio web:

// Mejorar el SEO de la imagen con texto alternativo generado por IA
const enhanceImageSEO = async (imageElement, apiKey) => {
  const canvas = document.createElement('canvas');
  const ctx = canvas.getContext('2d');
  canvas.width = imageElement.width;
  canvas.height = imageElement.height;
  ctx.drawImage(imageElement, 0, 0);

  const base64Image = canvas.toDataURL('image/jpeg');

  const response = await fetch('/api/v1/generate_alt_text', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${apiKey}`
    },
    body: JSON.stringify({ image: base64Image })
  });

  const result = await response.json();
  const { alt } = result.data.alt_text;

  // Actualizar el atributo alt de la imagen para SEO y accesibilidad
  if (alt && alt.length > 0) {
    imageElement.alt = alt[0];
  }
};

Integración con Gestión de Contenidos

Integre el generador de texto alternativo para imágenes en su flujo de trabajo de CMS:

# Procesar imágenes en lote en un sistema de gestión de contenidos
import os
import requests
from pathlib import Path

def bulk_generate_alt_text(directory_path, api_key):
    """Procesa todas las imágenes en un directorio para generar texto alternativo"""
    image_extensions = ['.jpg', '.jpeg', '.png', '.webp']

    for image_path in Path(directory_path).iterdir():
        if image_path.suffix.lower() in image_extensions:
            try:
                # Generar texto alternativo para cada imagen
                result = generate_alt_text(api_key, str(image_path))

                # Guardar metadatos en un archivo adjunto
                metadata_path = image_path.with_suffix('.json')
                with open(metadata_path, 'w') as f:
                    json.dump(result['data']['alt_text'], f, indent=2)

                print(f"Procesado: {image_path.name}")

            except Exception as e:
                print(f"Error procesando {image_path.name}: {e}")

# Uso
bulk_generate_alt_text("/ruta/a/las/imagenes", "su_clave_de_api")

Contáctenos

Si tiene alguna pregunta o sugerencia sobre nuestra API del Generador de Texto Alternativo con IA, no dude en contactarnos a través de los siguientes métodos:

¡Comience a usar la API del Generador de Texto Alternativo con IA ahora y libere el poder de la accesibilidad y el SEO de imágenes automatizados!