Documentation de l'API IA Image Describer (V2)

Introduction & Cas d'Utilisation

L'API IA Image Describer vous permet d'intégrer des capacités de description d'images alimentées par l'IA dans vos applications. Notre API utilise des modèles d'IA avancés pour analyser les images et générer des descriptions détaillées.

Cas d'Utilisation Courants

Générer des descriptions détaillées d'images
Extraire du texte et des informations des images
Analyser le contenu et le contexte des images
Créer des descriptions de personnages pour l'écriture créative
Générer des légendes d'images pour la gestion de contenu

Clés API

Pour utiliser notre API, vous devrez obtenir des identifiants API (Clé API et Secret). Vous pouvez gérer vos clés API dans le tableau de bord.

Gérer les Clés API →

Point d'Accès API

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

Guide d'Intégration

En-têtes de Requête

Nom de l'En-tête	Requis	Description
content-type	Oui	Doit être multipart/form-data
authorization	Oui	Doit être Bearer ${SECRET_KEY} ${SECRET_KEY} est votre clé API.

Paramètres de Requête

Paramètre	Type	Requis	Description
image	string ou file	Oui	Image pour générer la description. Accepte trois formats d'entrée : 1. URL d'image, commençant par http:// ou https://. 2. Image encodée en Base64, suivant le format : data:image/jpeg;base64,/9j/4AAQSkZJR... (Note : d'autres types d'images comme PNG sont également possibles, ajustez le mime-type en conséquence) 3. Objet Fichier : Un objet fichier représentant l'image modèle.
prompt	string	Oui	Prompt personnalisé pour l'analyse d'image
lang	string	Non	Langue de réponse (en/zh/de/es/fr/ja/ko/fi/nl/pt/tr/ru), par défaut : en

Format de Réponse

Champ	Type	Description
code	number	Code de statut de réponse. 200 pour succès
data	object	Objet de données de réponse, présent lorsque le code est 200
data.content	string	La description générée pour l'image
msg	string	Message de réponse, fournit des informations supplémentaires
succeed	boolean	Indique si la requête a réussi

Exemple de Réponse

{
    "code": 200,
    "data": {
        "content": "Description détaillée de l'image au format markdown..."
    },
    "succeed": true,
    "msg": "Succès"
}

Codes d'Erreur

Code	Message	Description
200	OK	Requête réussie
500	SERVER_ERROR	Erreur interne du serveur
10003	INSUFFICIENT_CREDITS	Crédits insuffisants
10004	INVALID_PARAM	Paramètres invalides
10005	HARMFUL_CONTENT	Contenu nuisible détecté
30001	INVALID_API_KEY	Clé API invalide
30002	INVALID_SIGNATURE	Signature de requête invalide

Exemples de Code

Exemple Curl avec URL d'Image

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="Décrivez brièvement le contenu de l'image"' \
--form 'lang="fr"'

Exemple Curl avec Fichier Image 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="Décrivez brièvement le contenu de l'image"' \
--form 'lang="fr"'

Exemple Curl avec Image 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="Décrivez brièvement le contenu de l'image"' \
--form 'lang="fr"'

Exemple Node.js

async function callDescribeImageApi() {
  const apiKey = 'YOUR_API_KEY'; // Remplacez par votre clé API réelle

  const formData = new FormData();
  formData.append('image', ...); // Supporte url, fichier image, image encodée en base64
  formData.append('prompt', 'Décrivez brièvement le contenu de l'image');
  formData.append('lang', 'fr'); // Code de langue de réponse

  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 || 'Erreur inconnue'}`);
    }

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

  } catch (error) {
    console.error('Erreur lors de la description de l'image:', error);
    return { content: null, error: error.message };
  }
}

Exemple Python

import requests
import base64

async def call_describe_image_api():
    api_key = 'YOUR_API_KEY'  # Remplacez par votre clé API réelle

    form_data = {
        'image': 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...',  # Exemple d'image Base64. Remplacez par vos données d'image réelles. Supporte url, fichier et base64.
        'prompt': 'Décrivez brièvement le contenu de l'image',
        'lang': 'fr' # Code de langue de réponse
    }

    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) # Utilisez files= pour multipart/form-data
        response.raise_for_status()  # Lève une exception pour les codes d'état d'erreur (4xx ou 5xx)

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

    except requests.exceptions.RequestException as e:
        print(f'Erreur lors de la description de l'image : {e}')
        return {'content': None, 'error': str(e)}

Tarification

Les appels API consomment des crédits de votre compte. Vous pouvez acheter des crédits sur notre page de tarification.

Voir les Tarifs →

Aide & Support

Si vous avez des questions ou besoin d'assistance, n'hésitez pas à contacter notre équipe de support.

Email : [email protected]