Documentation

API Reference

Core endpoints. All responses share one schema — field reference at Data Examples

POST /v1/search

L1 real-time retrieval: semantic + keyword across all three domains in one call.

Request bodyapplication/json
{
  "query": "string",           // required
  "domains": ["social","ecommerce","web"],
  "freshness": "24h",        // 1h–90d
  "format": "vectors+provenance",
  "limit": 20               // ≤100
}
RESPONSE TIME 821MS · STATUS 200application/json
{
  "id": "soc_xia_5c8a…",
  "src": "social",
  "platform": "xiaohongshu",
  "lang": "zh-CN",
  "text": "早八人通勤咖啡测评|这三家真的值",
  "author": {
    "uid_hash": "7be2…",
    "followers": 56900
  },
  "metrics": {
    "likes": 3204,
    "comments": 517,
    "saves": 1188
  },
  "comment_thread": [
    "第二家我也天天喝",
    "求地址!"
  ],
  "extra": {
    "note_type": "image",
    "topic": "#咖啡测评"
  },
  "vec": "[1536 dims]",
  "prov": {
    "hash": "0xf491d8d1",
    "ts": "2026-07-04T09:12:41+08:00"
  }
}

GET /v1/raw/{platform}/{resource}

L1 raw endpoints: platform-native structures (comment trees / creator graphs / price paths). Platform slugs per the directory

Examplecurl
curl "https://api.qovia.ai/v1/raw/douyin/comments?item_id=…&cursor=0" \
  -H "Authorization: Bearer $QOVIA_KEY"

GET /v1/datasets/slices

L2 dataset slices: filter by domain × platform × language × time-window; returns downloadable static corpus manifests.

Error codes

CodeMeaningBilled
400Bad requestNo
401Invalid API keyNo
402Insufficient creditsNo
429Rate limitedNo
200Success, non-empty payloadYes