API Reference

Quick Start

Start in drie stappen:

1. 1Maak een account aan en genereer een API key via Settings.
2. 2Voeg content toe via de dashboard of de Ingest API.
3. 3Stel je eerste vraag via POST /v1/ask.

curl -X POST https://axoverna.com/api/v1/ask \
  -H "Authorization: Bearer nx_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Which supplement helps with joint pain?"
  }'

Authentication

Alle API requests vereisen een Bearer token in de Authorization header.

Authorization: Bearer nx_live_YOUR_API_KEY

Er zijn drie typen API keys met verschillende toegangsniveaus:

Auth: nx_live_ or nx_adm_

Stel een vraag over je productcatalogus. Retourneert een AI-gegenereerd antwoord met bronvermeldingen en confidence score.

Request Parameters

Response

{
  "answer": "Joint Formula with glucosamine, MSM, and vitamin C...",
  "confidence": 0.94,
  "sources": [
    { "type": "product", "id": "JF-001", "title": "Joint Formula", "score": 0.96 },
    { "type": "manual", "page": 12, "title": "Product Guide", "score": 0.91 }
  ],
  "tokens_used": 342,
  "session_id": "sess_abc123"
}

Streaming (SSE)

Wanneer stream: true, retourneert de API een Server-Sent Events stream:

data: {"type":"chunk","text":"Joint Formula"}
data: {"type":"chunk","text":" with glucosamine..."}
data: {"type":"sources","sources":[...]}
data: {"type":"done","tokens_used":342}

Auth: nx_live_ or nx_adm_

Stuur feedback over een antwoord. Wordt gebruikt om de kwaliteit te meten en het model te verbeteren.

Request Parameters

Response

{ "success": true }

Auth: nx_ing_ or nx_adm_

Voeg items toe aan je knowledge base. Ondersteunt JSON batch (max 100 items) en multipart/form-data voor PDF uploads.

JSON Batch - Request Parameters

JSON Batch - Response

{
  "items_queued": 3,
  "job_ids": ["job_abc", "job_def", "job_ghi"],
  "status": "queued"
}

PDF Upload (multipart/form-data)

curl -X POST https://axoverna.com/api/v1/ingest/items \
  -H "Authorization: Bearer nx_ing_YOUR_KEY" \
  -F "file=@product-guide.pdf" \
  -F "type=manual" \
  -F "title=Product Guide 2025"

Auth: nx_ing_ or nx_adm_

Synchroniseer je volledige catalogus. Items worden vergeleken op external_id. Nieuwe items worden toegevoegd, gewijzigde items geüpdatet, en ontbrekende items verwijderd.

Request Parameters

Response

{
  "to_add": 5,
  "to_update": 2,
  "to_delete": 1,
  "job_ids": ["job_abc", "job_def"],
  "status": "queued"
}

Items die niet in het request voorkomen maar wel in je workspace bestaan worden soft-deleted. Wijzigingen worden gedetecteerd op basis van content, title en metadata.

Auth: nx_live_, nx_ing_ or nx_adm_

Controleer de status van een ingestion job. Poll dit endpoint na het aanmaken van items om te weten wanneer de content geïndexeerd is.

Response

{
  "id": "job_abc123",
  "type": "embed_item",
  "status": "done",
  "item_title": "Joint Formula",
  "item_type": "product",
  "attempts": 1,
  "error": null,
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:05Z"
}

Mogelijke statussen: queued, running, done, failed.

Widget Embed

Voeg de Axoverna chat widget toe aan je website met een enkel script tag. De widget is volledig aanpasbaar via data-attributen.

<script
  src="https://axoverna.com/widget.js"
  data-api-key="nx_live_YOUR_KEY"
  data-api-url="https://axoverna.com"
  data-title="Product Assistant"
  data-placeholder="Ask a question..."
  data-position="bottom-right"
  data-accent="#00D4C8"
></script>

Data Attributes

Error Codes

De API retourneert standaard HTTP status codes. Foutresponses bevatten altijd een error veld.

{
  "error": "Query limit exceeded for this billing period"
}

Rate Limiting

De API gebruikt een sliding window rate limiter. Limieten zijn afhankelijk van je plan en gelden per API key.

Bij overschrijding ontvang je een 429 Too Many Requests response. De Retry-After header geeft aan hoeveel seconden je moet wachten.

Naast rate limiting geldt ook een maandelijks query budget op basis van je plan. Controleer je gebruik via het Usage dashboard.