Documentação

Início Rápido

Comece com a API de Descrição de Imagem IA em apenas alguns minutos. Este guia irá orientá-lo através dos passos essenciais para integrar a descrição de imagem alimentada por IA em sua aplicação.

Pré-requisitos

Antes de começar, certifique-se de ter:

  • Conta: Registre-se em aidescribepicture.com
  • Chave API: Crie uma chave API nas configurações
  • Créditos: Compre créditos de descrição de imagem
  • URL da imagem: Uma URL de imagem publicamente acessível para testes

Passo 1: Obtenha Sua Chave API

  1. Visite aidescribepicture.com
  2. Faça login com sua conta Google
  3. Navegue para Configurações > Chaves API
  4. Clique no botão "Criar Nova Chave API"
  5. Digite um nome para a chave (ex. "Minha App")
  6. Após criar a chave, copie o valor completo da chave (mantenha-a segura!)

Formato da Chave API

  • Começa com sk-
  • Contém caracteres gerados aleatoriamente
  • Exemplo: sk-abc123def456ghi789...

Passo 2: Faça Sua Primeira Chamada API

Usando cURL

curl -X POST https://aidescribepicture.com/api/api-call/describe-picture \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "imageUrl": "https://example.com/image.jpg",
    "prompt": "Descreva esta imagem em detalhes"
  }'

Usando JavaScript

async function describeImage(imageUrl, apiKey, prompt = null) {
  try {
    const response = await fetch('https://aidescribepicture.com/api/api-call/describe-picture', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${apiKey}`
      },
      body: JSON.stringify({
        imageUrl: imageUrl,
        prompt: prompt
      })
    });
 
    if (!response.ok) {
      const error = await response.text();
      throw new Error(`Erro da API: ${response.status} - ${error}`);
    }
 
    const result = await response.json();
    
    // Extrair conteúdo da descrição
    const description = result.choices[0].message.content;
    return description;
  } catch (error) {
    console.error('Erro ao descrever imagem:', error);
    throw error;
  }
}
 
// Uso
const description = await describeImage(
  'https://example.com/image.jpg',
  'your-api-key-here',
  'Descreva esta imagem em detalhes'
);
console.log('Descrição da imagem:', description);

Passo 3: Lidar com a Resposta

A API retorna uma resposta JSON com a descrição da imagem:

{
  "choices": [
    {
      "message": {
        "content": "Esta imagem mostra uma raposa vermelha em close-up, olhando para a câmera. A raposa tem pelo laranja e branco fofo, com orelhas eretas e olhos castanhos brilhantes. O fundo está desfocado, possivelmente em um ambiente nevado ou cenário brilhante."
      }
    }
  ]
}

O campo choices[0].message.content contém o texto real da descrição da imagem.

Passo 4: Exibir o Resultado

Em HTML

<div id="description">
  <p id="image-description"></p>
</div>

Em JavaScript

// Exibir a descrição
const descriptionElement = document.getElementById('image-description');
descriptionElement.textContent = description;

Passo 5: Tratamento de Erros

Sempre implemente tratamento de erro adequado:

try {
  const description = await describeImage(imageUrl, apiKey, prompt);
  // Lidar com sucesso
  console.log('Descrição:', description);
} catch (error) {
  if (error.message.includes('401')) {
    console.error('Chave API inválida');
  } else if (error.message.includes('402')) {
    console.error('Créditos insuficientes');
  } else if (error.message.includes('429')) {
    console.error('Limite de taxa excedido');
  } else {
    console.error('Erro da API:', error.message);
  }
}

Gerenciamento de Chaves API

Gerenciando Chaves nas Configurações

  • Ver lista de todas as chaves API
  • Ver estatísticas de uso das chaves
  • Desativar ou excluir chaves não utilizadas
  • Ver última hora de uso das chaves

Melhores Práticas de Segurança

  • Nunca codifique chaves API no código do lado do cliente
  • Armazene chaves usando variáveis de ambiente
  • Rotacione chaves API regularmente
  • Use chaves diferentes para ambientes diferentes

Exemplo de Variáveis de Ambiente

# arquivo .env
IMAGE_DESCRIPTION_API_KEY=sk-your-api-key-here
// Usar no código
const apiKey = process.env.IMAGE_DESCRIPTION_API_KEY;