Документация API Текст из Фото (V2)

Введение и Случаи Использования

API Текст из Фото позволяет интегрировать возможности описания изображений на базе ИИ в ваши приложения. Наш API использует передовые модели ИИ для анализа изображений и генерации подробных описаний.

Типичные Случаи Использования

Генерация подробных описаний изображений
Извлечение текста и информации из изображений
Анализ содержания и контекста изображений
Создание описаний персонажей для творческого письма
Генерация подписей к изображениям для управления контентом

API Ключи

Для использования нашего API вам потребуются учетные данные API (API ключ и Secret). Вы можете управлять своими API ключами в панели управления.

Управление API Ключами →

Конечная Точка API

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

Руководство по Интеграции

Заголовки Запроса

Имя Заголовка	Обязательно	Описание
content-type	Да	Должен быть multipart/form-data
authorization	Да	Должен быть Bearer ${SECRET_KEY} ${SECRET_KEY} - это ваш API ключ.

Параметры Запроса

Параметр	Тип	Обязательно	Описание
image	string или file	Да	Изображение для генерации описания. Принимает три формата ввода: 1. URL изображения, начинающийся с http:// или https://. 2. Base64 Кодированное Изображение, в формате: data:image/jpeg;base64,/9j/4AAQSkZJR... (Примечание: другие типы изображений, такие как PNG, также возможны, соответственно настройте mime-type) 3. Объект Файла: Объект файла, представляющий модельное изображение.
prompt	string	Да	Пользовательский запрос для анализа изображения
lang	string	Нет	Язык ответа (en/zh/de/es/fr/ja/ko/fi/nl/pt/tr/ru), по умолчанию: en

Формат Ответа

Поле	Тип	Описание
code	number	Код статуса ответа. 200 для успеха
data	object	Объект данных ответа, присутствует когда code равен 200
data.content	string	Сгенерированное описание изображения
msg	string	Сообщение ответа, предоставляет дополнительную информацию
succeed	boolean	Указывает, был ли запрос успешным

Пример Ответа

{
    "code": 200,
    "data": {
        "content": "Подробное описание изображения в формате markdown..."
    },
    "succeed": true,
    "msg": "Успех"
}

Коды Ошибок

Код	Сообщение	Описание
200	OK	Запрос успешен
500	SERVER_ERROR	Внутренняя ошибка сервера
10003	INSUFFICIENT_CREDITS	Недостаточно кредитов
10004	INVALID_PARAM	Недопустимые параметры
10005	HARMFUL_CONTENT	Обнаружен вредоносный контент
30001	INVALID_API_KEY	Недействительный API ключ
30002	INVALID_SIGNATURE	Недействительная подпись запроса

Примеры Кода

Пример Curl с URL Изображения

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="Кратко опишите содержание изображения"' \
--form 'lang="ru"'

Пример Curl с Локальным Файлом Изображения

curl --location 'https://imagedescriber.online/api/openapi-v2/describe-image' \
--header 'Authorization: Bearer ${SECRET_KEY}' \
--form 'image=@"/PATH/TO/YOUR/IMAGE.jpg"' \
--form 'prompt="Кратко опишите содержание изображения"' \
--form 'lang="ru"'

Пример Curl с 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="Кратко опишите содержание изображения"' \
--form 'lang="ru"'

Пример Node.js

async function callDescribeImageApi() {
  const apiKey = 'YOUR_API_KEY'; // Замените на ваш реальный API ключ

  const formData = new FormData();
  formData.append('image', ...); // Поддерживает url, файл изображения, base64 кодированное изображение
  formData.append('prompt', 'Кратко опишите содержание изображения');
  formData.append('lang', 'ru'); // Код языка ответа

  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 || 'Неизвестная ошибка'}`);
    }

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

  } catch (error) {
    console.error('Ошибка при описании изображения:', error);
    return { content: null, error: error.message };
  }
}

Пример Python

import requests
import base64

async def call_describe_image_api():
    api_key = 'YOUR_API_KEY'  # Замените на ваш реальный API ключ

    form_data = {
        'image': 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...',  # Пример Base64 изображения. Замените на ваши реальные данные изображения. Поддерживает url, файл и base64.
        'prompt': 'Кратко опишите содержание изображения',
        'lang': 'ru' # Код языка ответа
    }

    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) # Используйте files= для multipart/form-data
        response.raise_for_status()  # Вызывает исключение для кодов статуса ошибки (4xx или 5xx)

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

    except requests.exceptions.RequestException as e:
        print(f'Ошибка при описании изображения: {e}')
        return {'content': None, 'error': str(e)}

Цены

Вызовы API потребляют кредиты с вашего счета. Вы можете приобрести кредиты на нашей странице цен.

Посмотреть Цены →

Помощь и Поддержка

Если у вас есть вопросы или нужна помощь, не стесняйтесь обращаться в нашу службу поддержки.

Email: [email protected]