Documentación

Inicio Rápido

Comienza con la API de Descripción de Imagen IA en solo unos minutos. Esta guía te llevará a través de los pasos esenciales para integrar la descripción de imagen impulsada por IA en tu aplicación.

Prerrequisitos

Antes de comenzar, asegúrate de tener:

  • Cuenta: Regístrate en aidescribepicture.com
  • Clave API: Crea una clave API en la configuración
  • Créditos: Compra créditos de descripción de imagen
  • URL de imagen: Una URL de imagen públicamente accesible para pruebas

Paso 1: Obtén Tu Clave API

  1. Visita aidescribepicture.com
  2. Inicia sesión con tu cuenta de Google
  3. Navega a Configuración > Claves API
  4. Haz clic en el botón "Crear Nueva Clave API"
  5. Ingresa un nombre para la clave (ej. "Mi App")
  6. Después de crear la clave, copia el valor completo de la clave (¡guárdala de forma segura!)

Formato de Clave API

  • Comienza con sk-
  • Contiene caracteres generados aleatoriamente
  • Ejemplo: sk-abc123def456ghi789...

Paso 2: Haz Tu Primera Llamada API

Usando cURL

curl -X POST https://aidescribepicture.com/api/api-call/describe-picture \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "imageUrl": "https://example.com/image.jpg",
    "prompt": "Describe esta imagen en detalle"
  }'

Usando JavaScript

async function describeImage(imageUrl, apiKey, prompt = null) {
  try {
    const response = await fetch('https://aidescribepicture.com/api/api-call/describe-picture', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${apiKey}`
      },
      body: JSON.stringify({
        imageUrl: imageUrl,
        prompt: prompt
      })
    });
 
    if (!response.ok) {
      const error = await response.text();
      throw new Error(`Error de API: ${response.status} - ${error}`);
    }
 
    const result = await response.json();
    
    // Extraer contenido de descripción
    const description = result.choices[0].message.content;
    return description;
  } catch (error) {
    console.error('Error al describir imagen:', error);
    throw error;
  }
}
 
// Uso
const description = await describeImage(
  'https://example.com/image.jpg',
  'your-api-key-here',
  'Describe esta imagen en detalle'
);
console.log('Descripción de imagen:', description);

Paso 3: Manejar la Respuesta

La API devuelve una respuesta JSON con la descripción de la imagen:

{
  "choices": [
    {
      "message": {
        "content": "Esta imagen muestra un zorro rojo en primer plano, mirando hacia la cámara. El zorro tiene pelaje naranja y blanco esponjoso, con orejas erguidas y ojos marrones brillantes. El fondo está desenfocado, posiblemente en un ambiente nevado o un entorno brillante."
      }
    }
  ]
}

El campo choices[0].message.content contiene el texto real de descripción de la imagen.

Paso 4: Mostrar el Resultado

En HTML

<div id="description">
  <p id="image-description"></p>
</div>

En JavaScript

// Mostrar la descripción
const descriptionElement = document.getElementById('image-description');
descriptionElement.textContent = description;

Paso 5: Manejo de Errores

Siempre implementa manejo de errores adecuado:

try {
  const description = await describeImage(imageUrl, apiKey, prompt);
  // Manejar éxito
  console.log('Descripción:', description);
} catch (error) {
  if (error.message.includes('401')) {
    console.error('Clave API inválida');
  } else if (error.message.includes('402')) {
    console.error('Créditos insuficientes');
  } else if (error.message.includes('429')) {
    console.error('Límite de tasa excedido');
  } else {
    console.error('Error de API:', error.message);
  }
}

Gestión de Claves API

Gestionando Claves en Configuración

  • Ver lista de todas las claves API
  • Ver estadísticas de uso de claves
  • Desactivar o eliminar claves no utilizadas
  • Ver última hora de uso de claves

Mejores Prácticas de Seguridad

  • Nunca codifiques claves API en código del lado del cliente
  • Almacena claves usando variables de entorno
  • Rota claves API regularmente
  • Usa claves diferentes para diferentes entornos

Ejemplo de Variables de Entorno

# archivo .env
IMAGE_DESCRIPTION_API_KEY=sk-your-api-key-here
// Usar en código
const apiKey = process.env.IMAGE_DESCRIPTION_API_KEY;