DeveloperDocs.api

Apps detail

Query app details and enrich missing store fields when needed.

POST/v1/apps/detail

DeveloperDocs.authentication: X-API-Key
DeveloperDocs.permission: apps:detail:read
DeveloperDocs.billing: DeveloperDocs.configuredBilling
DeveloperDocs.limits: DeveloperDocs.configuredLimits

DeveloperDocs.parameters

DeveloperDocs.jsonBody

platformstringDeveloperDocs.required

app_store · google_play

app_idstringDeveloperDocs.optional

bundle_idstringDeveloperDocs.optional

diandian_idstringDeveloperDocs.optional

sourcestringDeveloperDocs.optional

countrystringDeveloperDocs.optional

DeveloperDocs.defaultValue: "us"

langstringDeveloperDocs.optional

DeveloperDocs.defaultValue: "en"

DeveloperDocs.response

successbooleanDeveloperDocs.required

dataobjectDeveloperDocs.optional

详情页字段补齐结果。

DeveloperDocs.showFields

screenshotsarrayDeveloperDocs.optional

DeveloperDocs.showFields

DeveloperDocs.schemaUnavailable

descriptionstringDeveloperDocs.optional

ratingnumberDeveloperDocs.optional

rating_countintegerDeveloperDocs.optional

rating_count_listarrayDeveloperDocs.optional

DeveloperDocs.showFields

DeveloperDocs.schemaUnavailable

versionstringDeveloperDocs.optional

store_urlstringDeveloperDocs.optional

reviewsarrayDeveloperDocs.optional

DeveloperDocs.showFields

authorstringDeveloperDocs.optional

ratingnumberDeveloperDocs.optional

titlestringDeveloperDocs.optional

contentstringDeveloperDocs.optional

datestringDeveloperDocs.optional

versionstringDeveloperDocs.optional

countrystringDeveloperDocs.optional

rawobjectDeveloperDocs.optional

reviews_unavailable_reasonstringDeveloperDocs.optional

detail_unavailable_reasonstringDeveloperDocs.optional

applied_fieldsarrayDeveloperDocs.optional

DeveloperDocs.showFields

DeveloperDocs.schemaUnavailable

cache_statusstringDeveloperDocs.optional

hit · miss · stale · bypass

upstream_endpointstringDeveloperDocs.optional

applied_paramsobjectDeveloperDocs.optional

raw_realtimeobjectDeveloperDocs.optional

App & Gaming 实时接口响应。

DeveloperDocs.showFields

sourcestringDeveloperDocs.optional

DeveloperDocs.defaultValue: "collectx"

endpointstringDeveloperDocs.required

cache_statusstringDeveloperDocs.required

hit · miss · stale · bypass

cached_atstringDeveloperDocs.optional

ttl_secondsintegerDeveloperDocs.optional

upstream_endpointstringDeveloperDocs.required

applied_paramsobjectDeveloperDocs.optional

dataobjectDeveloperDocs.optional

errorobjectDeveloperDocs.optional

错误详情

DeveloperDocs.showFields

codeintegerDeveloperDocs.required

业务错误码

messagestringDeveloperDocs.required

可读错误信息

metaobjectDeveloperDocs.optional

响应元数据

DeveloperDocs.showFields

request_idstringDeveloperDocs.optional

请求唯一标识

DeveloperDocs.defaultValue: ""

pageintegerDeveloperDocs.optional

当前页码

sizeintegerDeveloperDocs.optional

每页数量

totalintegerDeveloperDocs.optional

总数

quota_remainingintegerDeveloperDocs.optional

剩余配额（-1 表示不限制）

DeveloperDocs.defaultValue: -1

service_levelstringDeveloperDocs.optional

本次请求的服务等级

langstringDeveloperDocs.optional

响应语言（cn/en），为空表示未翻译

platformstringDeveloperDocs.optional

本次请求的达人平台

recall_typestringDeveloperDocs.optional

召回类型：hybrid / vector / scalar

credits_consumedintegerDeveloperDocs.optional

本次请求扣减的积分数

DeveloperDocs.defaultValue: 0

credits_remainingintegerDeveloperDocs.optional

积分余额（-1 不限制）

DeveloperDocs.defaultValue: -1

billable_unitsintegerDeveloperDocs.optional

Server-calculated billable units for this response

DeveloperDocs.defaultValue: 0

0 ≤ billable_units ≤ ∞

skill_namestringDeveloperDocs.optional

调用方 skill 名称

skill_current_versionstringDeveloperDocs.optional

调用方 skill 当前版本

skill_latest_versionstringDeveloperDocs.optional

服务端声明的最新 skill 版本

skill_min_supported_versionstringDeveloperDocs.optional

服务端声明的最低支持版本

skill_update_availablebooleanDeveloperDocs.optional

是否存在可用 skill 更新

DeveloperDocs.defaultValue: false

skill_update_requiredbooleanDeveloperDocs.optional

是否要求更新 skill 后再继续使用

DeveloperDocs.defaultValue: false

skill_update_messagestringDeveloperDocs.optional

skill 更新提示文案

skill_update_manifest_urlstringDeveloperDocs.optional

skill 更新 manifest URL

DeveloperDocs.requestExample

curl -X POST 'https://openapi.creativault.ai/openapi/v1/apps/detail' \
  -H 'Content-Type: application/json' \
  -H "X-API-Key: $CV_API_KEY" \
  --data '{
  "platform": "google_play",
  "app_id": "example.app"
}'

DeveloperDocs.schemaExampleNotice

DeveloperDocs.responseExample

{
  "success": true,
  "data": {
    "screenshots": [
      "example"
    ],
    "description": "example",
    "rating": 1,
    "rating_count": 1,
    "rating_count_list": [
      1
    ],
    "version": "example",
    "store_url": "example",
    "reviews": [
      {
        "author": null,
        "rating": null,
        "title": null,
        "content": null,
        "date": null,
        "version": null,
        "country": null,
        "raw": {}
      }
    ],
    "reviews_unavailable_reason": "example",
    "detail_unavailable_reason": "example",
    "applied_fields": [
      "example"
    ],
    "cache_status": "hit",
    "upstream_endpoint": "example",
    "applied_params": {},
    "raw_realtime": {
      "source": "collectx",
      "endpoint": "example",
      "cache_status": "hit",
      "cached_at": null,
      "ttl_seconds": null,
      "upstream_endpoint": "example",
      "applied_params": {},
      "data": null
    }
  },
  "error": null,
  "meta": {
    "request_id": "",
    "page": 1,
    "size": 1,
    "total": 1,
    "quota_remaining": -1,
    "service_level": "example",
    "lang": "example",
    "platform": "example",
    "recall_type": "example",
    "credits_consumed": 0,
    "credits_remaining": -1,
    "billable_units": 0,
    "skill_name": "example",
    "skill_current_version": "example",
    "skill_latest_version": "example",
    "skill_min_supported_version": "example",
    "skill_update_available": false,
    "skill_update_required": false,
    "skill_update_message": "example",
    "skill_update_manifest_url": "example"
  }
}

DeveloperDocs.errorHelp →