Public Interface

API Reference & Integration

Connect your AI agents, bots, tools, and applications directly to E-Akivili's structured Honkai: Star Rail knowledge base and graph database.

REST & Model Context Protocol (MCP)

Machine-Readable Honkai: Star Rail Telemetry & Facts

All endpoints return standard JSON and support high-throughput AI retrieval, MCP agents, Discord bots, and interactive web tools.

Section

Core & Health

GET/api/health

Health & System Status

Returns health status, active dataset revision, entity count, and PostgreSQL database telemetry.

Example Request
curl -X GET https://e-akivili.vxnus.xyz/api/health
Example Response (JSON)
{
  "status": "healthy",
  "service": "e-akivili",
  "entityCount": 2662,
  "revision": "akivili:rev:2081db808514462ed79571a2d3a683b1f254c8c585b68d6acf1a9978f00aebaf",
  "installedAt": "2026-08-28T22:57:51.578Z",
  "timestamp": "2026-08-29T07:00:00.000Z"
}
Section

Entities & Relations

GET/api/entities

List & Search Entities

Search canonical Honkai: Star Rail entities (characters, light-cones, relics, items, books, messages) with pagination, category filter, and multilingual alias matching.

Parameters
qstringSearch query or multilingual alias keyword.
kindstringCategory filter (characters, light-cones, relics, items, books, messages).
limitnumberMaximum records to return (1-50, default 24).
pagenumberPagination page number (default 1).
Example Request
curl -X GET "https://e-akivili.vxnus.xyz/api/entities?kind=characters&q=march"
Example Response (JSON)
{
  "items": [
    {
      "id": "hsr:character:1001",
      "canonicalId": "hsr:character:1001",
      "category": "character",
      "kind": "characters",
      "slug": "march-7th",
      "name": "March 7th",
      "description": "A girl who once slumbered in eternal ice and knows nothing about her past.",
      "gameVersion": "4.5",
      "image": "https://raw.githubusercontent.com/Mar-7th/StarRailRes/master/icon/character/1001.png",
      "rarity": 4,
      "element": "Ice",
      "path": "Preservation",
      "aliases": [
        "March 7th",
        "三月七",
        "三月なのか",
        "Mar. 7th"
      ]
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 24,
  "revision": "akivili:rev:2081db808514...",
  "preview": false
}
GET/api/entities/:kind/:slug

Get Entity Details & Relations

Retrieve a single entity by kind and slug, along with its full canonical data and outgoing graph relations (ascension materials, relic suites, message contacts).

Parameters
kindstringrequiredEntity kind (characters, light-cones, relics, items, books, messages).
slugstringrequiredUnique slug identifier (e.g. march-7th, arrows).
Example Request
curl -X GET https://e-akivili.vxnus.xyz/api/entities/characters/march-7th
Example Response (JSON)
{
  "item": {
    "id": "hsr:character:1001",
    "slug": "march-7th",
    "name": "March 7th",
    "element": "Ice",
    "path": "Preservation",
    "rarity": 4
  },
  "relations": [
    {
      "id": "hsr:rel:...",
      "predicate": "requires_ascension_material",
      "object": {
        "id": "hsr:item:110141",
        "name": "Safeguard of Amber",
        "slug": "safeguard-of-amber"
      }
    }
  ],
  "revision": "akivili:rev:2081db..."
}
Section

Farming & Calyxes

GET/api/farming/daily

Daily Calyx Farming Schedule

Retrieves characters and light cones grouped by day of the week based on active Crimson Calyx rotation schedules.

Example Request
curl -X GET https://e-akivili.vxnus.xyz/api/farming/daily
Example Response (JSON)
{
  "days": {
    "1": {
      "dayName": "Monday",
      "chars": [
        {
          "name": "Acheron",
          "slug": "acheron",
          "element": "Lightning",
          "path": "Nihility"
        }
      ],
      "weapons": [
        {
          "name": "Along the Passing Shore",
          "slug": "along-the-passing-shore",
          "type": "Nihility"
        }
      ]
    }
  }
}
Section

AI & Knowledge Retrieval

GET/api/knowledge/search

Full-Text Lore & Knowledge Search

Performs PostgreSQL full-text rank search across 7,111 in-game books, character lore profiles, and daily messaging conversations.

Parameters
qstringrequiredFull-text search query (websearch syntax supported).
limitnumberMaximum chunks (default 8).
Example Request
curl -X GET "https://e-akivili.vxnus.xyz/api/knowledge/search?q=Astral+Express+Akivili"
Example Response (JSON)
{
  "items": [
    {
      "entity_id": "hsr:character:1001",
      "kind": "character",
      "slug": "march-7th",
      "name": "March 7th",
      "section": "character lore",
      "content": "A girl who once slumbered in eternal ice...",
      "rank": 0.0759
    }
  ],
  "preview": false
}
Section

Model Context Protocol (MCP)

POST/api/mcp

Model Context Protocol (MCP) Server

Streamable HTTP MCP endpoint exposing find_entity, get_entity, and search_knowledge tools for autonomous AI coding agents.

Example Request
curl -X POST https://e-akivili.vxnus.xyz/api/mcp -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
Example Response (JSON)
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "tools": [
      {
        "name": "find_entity",
        "description": "Search entities by name or alias"
      },
      {
        "name": "get_entity",
        "description": "Get entity details and graph relations"
      },
      {
        "name": "search_knowledge",
        "description": "Full-text lore search"
      }
    ]
  }
}