AurionAI Docs

Knowledge Base

Create and manage knowledge base articles programmatically via the Aurion API.

Knowledge Base

The Knowledge Base API lets you manage KB articles that power the AI agent's knowledge. Articles are synced with your ITSM provider and used for automated resolution and guided walkthroughs.

Search Articles

cURL
curl "https://apps.aurionai.net/api/v1/kb/articles?search=vpn+setup&limit=5" \
  -H "X-API-Key: ak_live_xxxx"
Python
import requests

response = requests.get(
    "https://apps.aurionai.net/api/v1/kb/articles",
    headers={"X-API-Key": "ak_live_xxxx"},
    params={"search": "vpn setup", "limit": 5},
)
articles = response.json()

Response:

{
  "data": [
    {
      "id": 101,
      "title": "How to Set Up VPN on Windows",
      "category": "Network",
      "status": "published",
      "views": 342,
      "helpful_votes": 28,
      "updated_at": "2026-02-15T09:00:00Z"
    }
  ],
  "total": 3,
  "limit": 5,
  "offset": 0
}

Query Parameters:

ParameterTypeDescription
searchstringFull-text search in title and content
categorystringFilter by category
statusstringFilter: published, draft
limitintegerResults per page (default: 25, max: 100)
offsetintegerNumber of results to skip

Get Article

curl "https://apps.aurionai.net/api/v1/kb/articles/101" \
  -H "X-API-Key: ak_live_xxxx"

Response:

{
  "id": 101,
  "title": "How to Set Up VPN on Windows",
  "content_html": "<h2>Prerequisites</h2><p>Before you begin...</p>",
  "category": "Network",
  "folder": "VPN & Remote Access",
  "tags": ["vpn", "windows", "network"],
  "status": "published",
  "views": 342,
  "helpful_votes": 28,
  "created_at": "2026-01-10T14:00:00Z",
  "updated_at": "2026-02-15T09:00:00Z"
}

Create Article (v2)

The v2 article creation endpoint accepts document uploads (PDF, DOCX, MD, TXT, HTML) and uses LLM processing to structure the content into a polished KB article.

curl -X POST "https://apps.aurionai.net/api/kb/create-v2" \
  -H "X-API-Key: ak_live_xxxx" \
  -F "file=@vpn-guide.pdf" \
  -F "title=VPN Setup Guide" \
  -F "category=Network"
Python
import requests

response = requests.post(
    "https://apps.aurionai.net/api/kb/create-v2",
    headers={"X-API-Key": "ak_live_xxxx"},
    files={"file": open("vpn-guide.pdf", "rb")},
    data={"title": "VPN Setup Guide", "category": "Network"},
)
article = response.json()

Response (201 Created):

{
  "id": 102,
  "title": "VPN Setup Guide",
  "status": "draft",
  "content_html": "<h2>Overview</h2><p>This guide covers...</p>",
  "processing": {
    "llm_provider": "anthropic",
    "tokens_used": 2450,
    "images_extracted": 3
  }
}

The LLM pipeline processes the document through: Parser → LLM Structuring (primary → failover → fallback) → Verifier → HTML Builder.

Rate Limits:

EndpointLimit
Preview article10/minute
Create article5/minute

Preview Before Creating

Preview how a document will be structured before committing:

curl -X POST "https://apps.aurionai.net/api/kb/preview-v2" \
  -H "X-API-Key: ak_live_xxxx" \
  -F "file=@vpn-guide.pdf"

KB Categories

curl "https://apps.aurionai.net/api/v1/kb/categories" \
  -H "X-API-Key: ak_live_xxxx"

Supported Upload Formats

FormatExtensionMax Size
PDF.pdf25 MB
Word.docx25 MB
Markdown.md10 MB
Plain text.txt10 MB
HTML.html10 MB

All uploads are scanned for malware before processing. Files exceeding the size limit or containing detected threats are rejected.


KB Management API (v2)

The v2 KB management endpoints provide full CRUD operations for articles and collections.

List Collections

curl "https://apps.aurionai.net/api/v2/kb/collections" \
  -H "X-API-Key: ak_live_xxxx"

Collection Tree

Get the hierarchical collection tree:

curl "https://apps.aurionai.net/api/v2/kb/collections/tree" \
  -H "X-API-Key: ak_live_xxxx"

Create Collection

curl -X POST "https://apps.aurionai.net/api/v2/kb/collections" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{"name": "Network", "description": "Network guides", "parent_id": null}'

Update Collection

curl -X PATCH "https://apps.aurionai.net/api/v2/kb/collections/{collection_id}" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{"name": "Networking"}'

Delete Collection

curl -X DELETE "https://apps.aurionai.net/api/v2/kb/collections/{collection_id}" \
  -H "X-API-Key: ak_live_xxxx"

Returns 204 No Content.

Reorder Collections

curl -X POST "https://apps.aurionai.net/api/v2/kb/collections/reorder" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{"order": ["col_1", "col_2", "col_3"]}'

List Articles (v2)

curl "https://apps.aurionai.net/api/v2/kb/articles?collection_id=col_1&limit=25" \
  -H "X-API-Key: ak_live_xxxx"

Get Article (v2)

curl "https://apps.aurionai.net/api/v2/kb/articles/{article_id}" \
  -H "X-API-Key: ak_live_xxxx"

Update Article

curl -X PATCH "https://apps.aurionai.net/api/v2/kb/articles/{article_id}" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{"title": "Updated Title", "content_html": "<p>Updated content</p>"}'

Delete Article

curl -X DELETE "https://apps.aurionai.net/api/v2/kb/articles/{article_id}" \
  -H "X-API-Key: ak_live_xxxx"

Returns 204 No Content. Soft-deletes the article.

Restore Article

curl -X POST "https://apps.aurionai.net/api/v2/kb/articles/{article_id}/restore" \
  -H "X-API-Key: ak_live_xxxx"

Publish Article

curl -X POST "https://apps.aurionai.net/api/v2/kb/articles/{article_id}/publish" \
  -H "X-API-Key: ak_live_xxxx"

Archive Article

curl -X POST "https://apps.aurionai.net/api/v2/kb/articles/{article_id}/archive" \
  -H "X-API-Key: ak_live_xxxx"

Rollback Article

Restore a previous version of an article:

curl -X POST "https://apps.aurionai.net/api/v2/kb/articles/{article_id}/rollback" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{"version": 2}'

Import Articles

Import articles from external sources:

Preview import
curl -X POST "https://apps.aurionai.net/api/v2/kb/import/preview" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{"source": "csv", "url": "https://example.com/articles.csv"}'
Execute import
curl -X POST "https://apps.aurionai.net/api/v2/kb/import/execute" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{"job_id": "job_abc123", "confirmed": true}'
Check import status
curl "https://apps.aurionai.net/api/v2/kb/import/status/{job_id}" \
  -H "X-API-Key: ak_live_xxxx"

Deleted Articles

View soft-deleted articles:

curl "https://apps.aurionai.net/api/v2/kb/articles/deleted" \
  -H "X-API-Key: ak_live_xxxx"

  • Help Center — Public self-service portal powered by your KB articles
  • Analytics — Track KB deflection and article performance

Required Scopes

ScopeEndpoints
kb:readGET /kb/articles, GET /kb/articles/:id, GET /kb/categories, all v2 GET endpoints
kb:writePOST /kb/create-v2, POST /kb/preview-v2, all v2 write endpoints

On this page