Docs / Início Rápido

Início Rápido

Do cadastro à sua primeira chamada de API em 5 minutos.

1. Criar uma Conta

  1. Vá para a página de cadastro e crie uma conta
  2. Verifique seu endereço de e-mail usando o link enviado para sua caixa de entrada
  3. Faça login na sua nova conta

2. Criar uma Coleção

  1. Clique em Coleções na barra lateral
  2. Clique em Nova Coleção
  3. Dê um nome, por exemplo Meus Documentos

3. Enviar um Documento

  1. Abra sua coleção
  2. Clique em Enviar Documento
  3. Escolha um PDF, documento Word, arquivo Markdown, planilha, arquivo de texto, ou cole texto simples. Você pode selecionar múltiplos arquivos de uma vez.
  4. Aguarde o processamento — o status muda de Pendente → Processando → Indexado

Você também pode enviar documentos via API. Consulte a Referência da API para detalhes completos.

curl -X POST https://YOUR_INSTANCE/api/v1/collections/{uuid}/documents/ \
  -H "Authorization: Bearer aqn_YOUR_API_KEY" \
  -F "file=@document.pdf"

4. Conectar o Claude

Claude Desktop: Vá para Personalizar → Conectores → clique em + → Adicionar conector personalizado → digite o nome aqoon e URL https://aqoon.ai/mcp/ → clique em Conectar → faça login e aprove. Pronto!

Claude Code: Você precisará de uma chave de API (veja o próximo passo).

5. Obter uma Chave de API (Claude Code / API)

  1. Vá para Chaves de API
  2. Clique em Criar Nova Chave
  3. Escolha Acesso total para testes
  4. Copie a chave imediatamente — ela começa com aqn_ e não será exibida novamente

6. Faça Sua Primeira Chamada de API

cURL:

curl -X POST https://YOUR_INSTANCE/api/v1/search/ \
  -H "Authorization: Bearer aqn_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "your search query"}'

SDK Python:

pip install aqoon
from aqoon import Aqoon

client = Aqoon(api_key="aqn_YOUR_API_KEY")
results = client.search("your search query")

for r in results["results"]:
    print(r["title"], r["score"])

SDK JavaScript:

npm install @54startups/aqoon
import { Aqoon } from '@54startups/aqoon';

const client = new Aqoon({ apiKey: 'aqn_YOUR_API_KEY' });
const results = await client.search('your search query');

results.results.forEach(r => console.log(r.title, r.score));

Consulte a página de SDKs para documentação completa incluindo envio de documentos, gerenciamento de coleções e gerenciamento de chaves de API.

7. Próximos Passos?