Documentação da API do Descritor de Imagem (V2)

Introdução & Casos de Uso

A API do Descritor de Imagem permite que você integre recursos de descrição de imagens alimentados por IA em seus aplicativos. Nossa API usa modelos avançados de IA para analisar imagens e gerar descrições detalhadas.

Casos de Uso Comuns

Gerar descrições detalhadas de imagens
Extrair texto e informações de imagens
Analisar conteúdo e contexto de imagens
Criar descrições de personagens para escrita criativa
Gerar legendas de imagens para gerenciamento de conteúdo

Chaves de API

Para usar nossa API, você precisará obter credenciais de API (Chave API e Secret). Você pode gerenciar suas chaves API no painel.

Gerenciar Chaves API →

Endpoint da API

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

Guia de Integração

Cabeçalhos da Requisição

Nome do Cabeçalho	Obrigatório	Descrição
content-type	Sim	Deve ser multipart/form-data
authorization	Sim	Deve ser Bearer ${SECRET_KEY} ${SECRET_KEY} é sua chave API.

Parâmetros da Requisição

Parâmetro	Tipo	Obrigatório	Descrição
image	string ou file	Sim	Imagem para gerar descrição. Aceita três formatos de entrada: 1. URL da imagem, começando com http:// ou https://. 2. Imagem codificada em Base64, seguindo o formato: data:image/jpeg;base64,/9j/4AAQSkZJR... (Nota: outros tipos de imagem como PNG também são possíveis, ajuste o mime-type adequadamente) 3. Objeto de arquivo: Um objeto de arquivo representando a imagem modelo.
prompt	string	Sim	Prompt personalizado para análise de imagem
lang	string	Não	Idioma da resposta (en/zh/de/es/fr/ja/ko/fi/nl/pt/tr/ru), padrão: en

Formato da Resposta

Campo	Tipo	Descrição
code	number	Código de status da resposta. 200 para sucesso
data	object	Objeto de dados da resposta, presente quando o código é 200
data.content	string	A descrição gerada para a imagem
msg	string	Mensagem da resposta, fornece informações adicionais
succeed	boolean	Indica se a requisição foi bem-sucedida

Exemplo de Resposta

{
    "code": 200,
    "data": {
        "content": "Descrição detalhada da imagem em formato markdown..."
    },
    "succeed": true,
    "msg": "Sucesso"
}

Códigos de Erro

Código	Mensagem	Descrição
200	OK	Requisição bem-sucedida
500	SERVER_ERROR	Erro interno do servidor
10003	INSUFFICIENT_CREDITS	Créditos insuficientes
10004	INVALID_PARAM	Parâmetros inválidos
10005	HARMFUL_CONTENT	Conteúdo prejudicial detectado
30001	INVALID_API_KEY	Chave API inválida
30002	INVALID_SIGNATURE	Assinatura de requisição inválida

Exemplos de Código

Exemplo de Curl com URL de Imagem

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="Descreva brevemente o conteúdo da imagem"' \
--form 'lang="pt"'

Exemplo de Curl com Arquivo de Imagem 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="Descreva brevemente o conteúdo da imagem"' \
--form 'lang="pt"'

Exemplo de Curl com Imagem 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="Descreva brevemente o conteúdo da imagem"' \
--form 'lang="pt"'

Exemplo Node.js

async function callDescribeImageApi() {
  const apiKey = 'YOUR_API_KEY'; // Substitua pela sua chave API real

  const formData = new FormData();
  formData.append('image', ...); // Suporta url, arquivo de imagem, imagem codificada em base64
  formData.append('prompt', 'Descreva brevemente o conteúdo da imagem');
  formData.append('lang', 'pt'); // Código do idioma da resposta

  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 || 'Erro desconhecido'}`);
    }

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

  } catch (error) {
    console.error('Erro ao descrever a imagem:', error);
    return { content: null, error: error.message };
  }
}

Exemplo Python

import requests
import base64

async def call_describe_image_api():
    api_key = 'YOUR_API_KEY'  # Substitua pela sua chave API real

    form_data = {
        'image': 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...',  # Exemplo de imagem Base64. Substitua pelos seus dados de imagem reais. Suporta url, arquivo e base64.
        'prompt': 'Descreva brevemente o conteúdo da imagem',
        'lang': 'pt' # Código do idioma da resposta
    }

    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) # Use files= para multipart/form-data
        response.raise_for_status()  # Lança uma exceção para códigos de status de erro (4xx ou 5xx)

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

    except requests.exceptions.RequestException as e:
        print(f'Erro ao descrever a imagem: {e}')
        return {'content': None, 'error': str(e)}

Preços

As chamadas da API consomem créditos da sua conta. Você pode comprar créditos em nossa página de preços.

Ver Preços →

Ajuda & Suporte

Se você tiver alguma dúvida ou precisar de assistência, não hesite em contatar nossa equipe de suporte.

Email: [email protected]