Volver a la página de inicio

Documentación de la API Image Describer - Generación de Descripción de Imágenes con IA

Resumen

La API Image Describer es una poderosa herramienta de generación de descripción de imágenes que produce de forma inteligente descripciones precisas, detalladas y perspicaces de imágenes basadas en la imagen y el prompt proporcionados. Esta API de reconocimiento de imágenes impulsada por IA entiende y analiza el contenido de la imagen, generando las descripciones textuales correspondientes de acuerdo con sus indicaciones. Es ampliamente aplicable a diversos escenarios que involucran comprensión de imágenes, análisis de imágenes y generación de contenido de imágenes, lo que le permite implementar fácilmente respuestas a preguntas sobre imágenes y conversión de imagen a texto.

Escenarios de Aplicación

La API Image Describer puede ayudarle a realizar de manera eficiente la comprensión de imágenes y la generación de contenido en las siguientes áreas:

Claves API

Para acceder a la API Image Describer, primero debe obtener una clave API válida. Esta clave se utiliza para autenticar sus solicitudes y garantizar un acceso seguro a la API.

Obtención de una Clave API

  1. Acceda a la Página de Administración de Claves API: Inicie sesión en el sistema y 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 Administración de Claves API.
API for Image Describer
  1. Cree 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".
API for Image Describer
  1. Copie y Guarde su Clave: Tenga en cuenta que la clave solo se mostrará completa una vez. Haga clic en el icono de copia para copiar la clave en 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, el código del lado del cliente ni en ningún otro lugar inseguro. Mantenga su clave segura para evitar el acceso no autorizado.

Punto de Conexión de la API

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

Parámetros de la Solicitud

Encabezados de la Solicitud

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

Cuerpo de la Solicitud

{
  "image": "data:image/jpeg;base64,{image_base64_data}",
  "prompt": "¿Qué es este objeto? Describe sus posibles usos.",
  "lang": "es"
}
ParámetroTipoObligatorioDescripción
imagestring

La URL o los datos codificados en Base64 de la imagen. Los formatos de imagen admitidos se enumeran en Detalles de Formato de Imagen.

promptstringNoLa pregunta o solicitud de descripción para la imagen, por ejemplo, "¿Qué es esto?" o "Describe esta imagen."
langstringNoEl código de idioma para la descripción devuelta. 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)
zhChino
frFrancés
deAlemán
esEspañol
jaJaponés
koCoreano

Ejemplo de Solicitud (cURL)

curl --location 'https://api.imagedescriber.app/api/v1/generate_content' \
--header 'content-type: application/json' \
--header 'authorization: Bearer your_api_key' \
--data '{
    "image":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQE...",
    "prompt":"¿Qué es este objeto? Describe sus posibles usos.",
    "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_image_description(api_key, image_path, prompt, lang="es"):
  """Genera una descripción de imagen utilizando la API Image Describer"""
  url = "https://api.imagedescriber.app/api/v1/generate_content"
  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}",
      "prompt": prompt,
      "lang": lang
  }

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

  if response.status_code == 200:
      result = response.json()
      print(result["data"]["content"])
  else:
    print(f"Error: {response.status_code}")
    print(response.text)

# Uso de ejemplo
api_key = "your_api_key"
image_path = "your_image.jpg"
prompt = "¿Qué es este objeto? Describe sus posibles usos."

generate_image_description(api_key, image_path, prompt, lang="es")

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 del evento de entrada o 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,
  "prompt": "Describe la imagen en detalle",
  "lang": "es"
};

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

const result = await response.json();
console.log(result);

Respuesta

Cuerpo de la Respuesta (Respuesta JSON)

La API ahora devuelve la respuesta completa en un solo objeto JSON. El campo content dentro del objeto data contiene la descripción de la imagen generada en formato Markdown.

{
  "code": 0,
  "message": "éxito",
  "request_id": "cadena_única_de_id_de_solicitud",
  "data": {
    "content": "Contenido generado en formato Markdown"
  }
}
CampoTipoDescripción
codenúmeroCódigo de estado, `0` indica éxito, no `0` indica un error.
messagecadenaMensaje de estado, describe el estado de la solicitud.
request_idcadenaID de solicitud único, utilizado para seguimiento y solución de problemas.
datacadenaContiene el contenido generado. Formato Markdown.
contentcadenaEl texto de la **descripción de la imagen** generada. El formato es **Markdown**.

Límites de Solicitud

Para garantizar la estabilidad y la equidad del servicio, cada clave API está limitada a 5 solicitudes por minuto (300 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 para admitir 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 API InválidaVerifique que su clave API sea correcta u obtenga una nueva.
1004Demasiadas SolicitudesReduzca la frecuencia de sus solicitudes, máximo 5 solicitudes por minuto.
1005Parámetros InválidosVerifique que los parámetros de su solicitud cumplan con las especificaciones.
2002Créditos Insuficientes
2003Contenido Bloqueado por el FiltroModifique su imagen o indicación para asegurarse de que el contenido cumpla con las regulaciones.
2004Formato de Imagen Inválido

Utilice un formato de imagen compatible, consulte Detalles de Formato de Imagen.

2005Error al Subir la ImagenVerifique que la URL de su imagen sea válida o intente subirla de nuevo más tarde.
5050Error Interno del ServidorPóngase en contacto con nuestro equipo de soporte técnico y proporcione el `request_id`.

Detalles de Formato de Imagen

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

Contáctenos

Si tiene alguna pregunta o sugerencia, no dude en contactarnos a través de los siguientes métodos:

¡Comience a utilizar la API Image Describer ahora y desbloquee las posibilidades ilimitadas de la comprensión de imágenes!