Docs / Quickstart

Quickstart

From registration to your first API call in 5 minutes.

1. Create an Account

  1. Go to the registration page and create an account
  2. Verify your email address using the link sent to your inbox
  3. Log in to your new account

2. Create a Collection

  1. Click Collections in the sidebar
  2. Click New Collection
  3. Give it a name, for example My Documents

3. Upload a Document

  1. Open your collection
  2. Click Upload Document
  3. Choose a PDF, Word doc, Markdown file, spreadsheet, text file, or paste plain text. You can select multiple files at once.
  4. Wait for processing — the status moves from Pending → Processing → Indexed

You can also upload documents via the API. See the API Reference for full details.

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

4. Connect Claude

Claude Desktop: Go to Customize → Connectors → click + → Add custom connector → enter name aqoon and URL https://aqoon.ai/mcp/ → click Connect → log in and approve. Done!

Claude Code: You will need an API key (see next step).

5. Get an API Key (Claude Code / API)

  1. Go to API Keys
  2. Click Create New Key
  3. Choose Full access for testing
  4. Copy the key immediately — it starts with aqn_ and won't be shown again

6. Make Your First API Call

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"}'

Python SDK:

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"])

JavaScript SDK:

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));

See the SDKs page for full documentation including document upload, collection management, and API key management.

7. What's Next?