Documentación de la API de IA Explica imagen (V2)

Introducción y Casos de Uso

La API de IA Explica imagen le permite integrar capacidades de descripción de imágenes impulsadas por IA en sus aplicaciones. Nuestra API utiliza modelos avanzados de IA para analizar imágenes y generar descripciones detalladas.

Casos de Uso Comunes

Generar descripciones detalladas de imágenes
Extraer texto e información de imágenes
Analizar contenido y contexto de imágenes
Crear descripciones de personajes para escritura creativa
Generar subtítulos de imágenes para gestión de contenido

Claves de API

Para usar nuestra API, necesitará obtener credenciales de API (Clave API y Secreto). Puede gestionar sus claves API en el panel de control.

Gestionar Claves API →

Endpoint de API

POST https://imagedescriber.online/api/openapi-v2/describe-image

Guía de Integración

Encabezados de Solicitud

Nombre del Encabezado	Requerido	Descripción
content-type	Sí	Debe ser multipart/form-data
authorization	Sí	Debe ser Bearer ${SECRET_KEY} ${SECRET_KEY} es su clave API.

Parámetros de Solicitud

Parámetro	Tipo	Requerido	Descripción
image	string o file	Sí	Imagen para generar descripción. Acepta tres formatos de entrada: 1. URL de imagen, comenzando con http:// o https://. 2. Imagen codificada en Base64, siguiendo el formato: data:image/jpeg;base64,/9j/4AAQSkZJR... (Nota: otros tipos de imagen como PNG también son posibles, ajuste el mime-type según corresponda) 3. Objeto de archivo: Un objeto de archivo que representa la imagen modelo.
prompt	string	Sí	Prompt personalizado para el análisis de imagen
lang	string	No	Idioma de respuesta (en/zh/de/es/fr/ja/ko/fi/nl/pt/tr/ru), predeterminado: en

Formato de Respuesta

Campo	Tipo	Descripción
code	number	Código de estado de respuesta. 200 para éxito
data	object	Objeto de datos de respuesta, presente cuando el código es 200
data.content	string	La descripción generada para la imagen
msg	string	Mensaje de respuesta, proporciona información adicional
succeed	boolean	Indica si la solicitud fue exitosa

Ejemplo de Respuesta

{
    "code": 200,
    "data": {
        "content": "Descripción detallada de la imagen en formato markdown..."
    },
    "succeed": true,
    "msg": "Éxito"
}

Códigos de Error

Código	Mensaje	Descripción
200	OK	Solicitud exitosa
500	SERVER_ERROR	Error interno del servidor
10003	INSUFFICIENT_CREDITS	Créditos insuficientes
10004	INVALID_PARAM	Parámetros inválidos
10005	HARMFUL_CONTENT	Contenido dañino detectado
30001	INVALID_API_KEY	Clave API inválida
30002	INVALID_SIGNATURE	Firma de solicitud inválida

Ejemplos de Código

Ejemplo de Curl con URL de Imagen

curl --location 'https://imagedescriber.online/api/openapi-v2/describe-image' \
--header 'Authorization: Bearer ${SECRET_KEY}' \
--form 'image="https://persistent.imagedescriber.online/image-describer-examples/000.jpg"' \
--form 'prompt="Describe brevemente el contenido de la imagen"' \
--form 'lang="es"'

Ejemplo de Curl con Archivo de Imagen Local

curl --location 'https://imagedescriber.online/api/openapi-v2/describe-image' \
--header 'Authorization: Bearer ${SECRET_KEY}' \
--form 'image=@"/PATH/TO/YOUR/IMAGE.jpg"' \
--form 'prompt="Describe brevemente el contenido de la imagen"' \
--form 'lang="es"'

Ejemplo de Curl con Imagen Base64

curl --location 'https://imagedescriber.online/api/openapi-v2/describe-image' \
--header 'Authorization: Bearer ${SECRET_KEY}' \
--form 'image="data:image/jpeg;base64,/9j……/9k="' \
--form 'prompt="Describe brevemente el contenido de la imagen"' \
--form 'lang="es"'

Ejemplo de Node.js

async function callDescribeImageApi() {
  const apiKey = 'YOUR_API_KEY'; // Reemplazar con su clave API real

  const formData = new FormData();
  formData.append('image', ...); // Soporta url, archivo de imagen, imagen codificada en base64
  formData.append('prompt', 'Describe brevemente el contenido de la imagen');
  formData.append('lang', 'es'); // Código de idioma de respuesta

  const apiEndpoint = 'https://imagedescriber.online/api/openapi-v2/describe-image';
  try {
    const response = await fetch(apiEndpoint, {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${apiKey}`,
      },
      body: formData,
    });

    if (!response.ok) {
      const errorData = await response.json();
      throw new Error(`HTTP error ${response.status}: ${errorData.msg || 'Error desconocido'}`);
    }

    const data = await response.json();
    return { content: data.data.content, error: null };

  } catch (error) {
    console.error('Error al describir la imagen:', error);
    return { content: null, error: error.message };
  }
}

Ejemplo de Python

import requests
import base64

async def call_describe_image_api():
    api_key = 'YOUR_API_KEY'  # Reemplazar con su clave API real

    form_data = {
        'image': 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...',  # Ejemplo de imagen Base64. Reemplazar con sus datos de imagen reales. Soporta url, archivo y base64.
        'prompt': 'Describe brevemente el contenido de la imagen',
        'lang': 'es' # Código de idioma de respuesta
    }

    api_endpoint = 'https://imagedescriber.online/api/openapi-v2/describe-image'
    try:
        headers = {
            'Authorization': f'Bearer {api_key}',
        }

        response = requests.post(api_endpoint, files=form_data, headers=headers) # Usar files= para multipart/form-data
        response.raise_for_status()  # Lanza una excepción para códigos de estado de error (4xx o 5xx)

        data = response.json()
        return {'content': data.get('data', {}).get('content'), 'error': None}

    except requests.exceptions.RequestException as e:
        print(f'Error al describir la imagen: {e}')
        return {'content': None, 'error': str(e)}

Precios

Las llamadas a la API consumen créditos de su cuenta. Puede comprar créditos en nuestra página de precios.

Ver Precios →

Ayuda y Soporte

Si tiene alguna pregunta o necesita asistencia, no dude en contactar a nuestro equipo de soporte.

Email: [email protected]