Help Center
Configure and manage the public Help Center portal via the Aurion API.
Help Center
The Help Center API manages the public-facing knowledge base portal where end-users can browse articles, search for solutions, and submit feedback. The Help Center is available at a dedicated subdomain (e.g., help.yourcompany.com).
Configuration
Get the Help Center configuration for your tenant:
curl "https://apps.aurionai.net/api/v1/help-center/config" \
-H "X-API-Key: ak_live_xxxx"Response:
{
"enabled": true,
"title": "Acme Support Center",
"description": "Find answers, browse guides, and get help",
"branding": {
"primary_color": "#6366F1",
"logo_url": "https://example.com/logo.png"
},
"features": {
"ai_summary": true,
"feedback": true,
"contact_form": true,
"search": true
}
}Public Endpoints
These endpoints are used by the Help Center portal and don't require API key authentication:
Resolve Tenant
Resolve a hostname to a tenant. Used by the Help Center frontend to determine which tenant's content to display. Supports subdomain patterns ({slug}.help.aurionai.net), custom domains, and the default bare domain.
curl "https://apps.aurionai.net/api/v1/help-center/resolve-tenant?hostname=acme.help.aurionai.net"Response:
{
"tenant_id": "550e8400-e29b-41d4-a716-446655440000",
"tenant_slug": "acme",
"tenant_name": "Acme Corp"
}Landing Page
Fetch landing page data including top-level collections and popular articles:
curl "https://apps.aurionai.net/api/v1/help-center/landing?tenant_id=TENANT_UUID&locale=en"List Collections
Retrieve the hierarchical collection (category) tree for the Help Center:
curl "https://apps.aurionai.net/api/v1/help-center/collections?tenant_id=TENANT_UUID&locale=en"Get Settings
Retrieve public Help Center settings (enabled features, title, description):
curl "https://apps.aurionai.net/api/v1/help-center/settings?tenant_id=TENANT_UUID"Browse Articles
curl "https://apps.aurionai.net/api/v1/help-center/articles?category=Getting+Started&limit=10"Search
curl "https://apps.aurionai.net/api/v1/help-center/search?q=vpn+setup"Search with AI Summary
Search articles and return an AI-generated summary of the top results. Rate-limited to 10 requests per minute.
curl "https://apps.aurionai.net/api/v1/help-center/search-summary?search=vpn+setup&tenant_id=TENANT_UUID&locale=en&limit=5"Response:
{
"summary": "To set up VPN access, install the company VPN client and...",
"articles": [
{"id": "101", "title": "VPN Setup Guide", "score": 0.95}
]
}Get Article
curl "https://apps.aurionai.net/api/v1/help-center/articles/101"AI Summary
Get an AI-generated summary of an article (requires ai_summary feature enabled):
curl "https://apps.aurionai.net/api/v1/help-center/articles/101/summary"Submit Feedback
curl -X POST "https://apps.aurionai.net/api/v1/help-center/articles/101/feedback" \
-H "Content-Type: application/json" \
-d '{
"helpful": true,
"comment": "This solved my issue, thanks!"
}'Contact Form Schema
Retrieve the dynamic form schema for the contact form, based on custom field definitions configured by the tenant:
curl "https://apps.aurionai.net/api/v1/help-center/contact-form/schema?tenant_id=TENANT_UUID"Contact Form
curl -X POST "https://apps.aurionai.net/api/v1/help-center/contact" \
-H "Content-Type: application/json" \
-d '{
"name": "Jane Smith",
"email": "jane@example.com",
"subject": "Cannot find VPN article",
"message": "I need help setting up VPN but cannot find the right article."
}'Ticket Form Schema
Retrieve the portal form schema for conversation/ticket creation. Returns JSON Schema and UI Schema for rendering the form, including branding and file-upload settings:
curl "https://apps.aurionai.net/api/v1/help-center/ticket-form/schema?tenant_id=TENANT_UUID&locale=en"Response:
{
"schema": { "type": "object", "properties": { "subject": { "type": "string" } } },
"ui_schema": {},
"form_id": "form_abc123",
"form_version": 2,
"branding": { "primary_color": "#6366F1" }
}Admin Branding Endpoints
These endpoints require admin authentication and manage Help Center branding (logo, favicon, colors, custom CSS).
Get Branding
curl "https://apps.aurionai.net/api/v1/help-center/admin/branding" \
-H "X-API-Key: ak_live_xxxx"Update Branding
curl -X PATCH "https://apps.aurionai.net/api/v1/help-center/admin/branding" \
-H "X-API-Key: ak_live_xxxx" \
-H "Content-Type: application/json" \
-d '{
"primary_color": "#4F46E5",
"footer_show_powered_by": false
}'Upload Branding Assets
Upload logo and/or favicon files (max 2 MB each, PNG/JPG/SVG/ICO/WebP):
curl -X POST "https://apps.aurionai.net/api/v1/help-center/admin/branding/upload" \
-H "X-API-Key: ak_live_xxxx" \
-F "logo=@logo.png" \
-F "favicon=@favicon.ico"Categories
The Help Center organizes articles into categories and subcategories. Categories are managed through the admin dashboard or KB API.
Deflection Analytics
Track how effectively the Help Center deflects support tickets. View metrics in the Analytics dashboard or via the analytics API.
Related Guides
- Knowledge Base — Manage KB articles powering the Help Center
- Analytics — Help Center deflection metrics
Authentication
Help Center public endpoints (article browsing, search, feedback, contact form) do not require API key authentication. They are designed for unauthenticated end-user access.
The admin configuration endpoint (GET /v1/help-center/config) and branding endpoints (/v1/help-center/admin/branding) require an API key with the config:read or config:write scope.