LinkfoxAI agent and documentation index

Fetch the complete documentation index at: /llms.txt

Read when and how to use LinkfoxAI at: /agent-instructions.txt

Machine-readable API description: LinkfoxAI OpenAPI specification

Use this file to discover all available pages before exploring further.

LinkfoxAI logo
开始使用
API对接文档

AI分析

按所需结果选择接口:描述词分析用于生成作图或视频提示词;商品信息分析用于提取完整商品 JSON。两类任务须分别使用对应的创建和查询接口,任务编号不能混用。

描述词分析

POST/v2/process/result/imageToPrompt/createapplication/json

请求体

typestring必填
应用类型
5、相似图裂变
13、场景裂变
30、图转视频商品分析
69、穿衣套图卖点分析
71、商品套图卖点分析
73、带货口播视频脚本
89、视频复刻提示词
imageUrlListList必填
图片地址列表(图转视频商品分析、套图卖点分析、带货口播视频脚本支持多张,最多6张;视频复刻提示词为参考图片列表,最多6张)
keywordstring可选
关键字
1.场景裂变此参数有效
2.图转视频商品分析商品信息可通过当前字段传入,不能超过2500字符
3.套图卖点分析商品信息可通过当前字段传入
4.带货口播视频脚本商品信息可通过当前字段传入
5.视频复刻提示词商品信息可通过当前字段传入,不能超过2500字符
providerstring可选默认API_PRE_POINT
套图模式需传入提取类型用于区分功能
API_PRE_POINT 卖点分析
API_LAYOUT_DESC 排版描述
refVideoUrlstring可选
参考视频地址(type=89 视频复刻提示词时必填)
saleCountrystring可选
销售国家或地区(type=73 用于生成符合目标市场的带货口播脚本;type=89 用于视频复刻提示词)
targetLanguagestring可选
目标语言(type=73 用于控制带货口播脚本语言;type=89 用于视频复刻提示词)
durationinteger可选
目标视频时长(秒,type=73 用于规划口播内容和分镜;type=89 用于视频复刻提示词)

请求示例(type≠89时)

JSON
{
    "imageUrlList": ["https://linkfoxai-ailab.oss-cn-shenzhen.aliyuncs.com/UPLOAD/1831963161548988416/2025/04/11/1bf6df8e4f4244fab620a804307d5412.jpg?Expires=1749490711&OSSAccessKeyId=LTAI5tHc6aeQ2BxZpF3QTE15&Signature=BOa3Or9gpH0InQxwTQwDBKiy9oU%3D"],
    "type": 69,
    "keyword": "商品信息"
}

图转视频商品分析请求示例(type=30时)

JSON
{
    "type": 30,
    "imageUrlList": [
        "https://example.com/product-image-1.jpg",
        "https://example.com/product-image-2.jpg"
    ],
    "keyword": "商品名称:无线蓝牙耳机;卖点:降噪、长续航、佩戴舒适"
}

带货口播视频脚本请求示例(type=73时)

JSON
{
    "type": 73,
    "imageUrlList": [
        "https://example.com/product-image-1.jpg",
        "https://example.com/product-image-2.jpg"
    ],
    "keyword": "商品名称:无线蓝牙耳机;卖点:降噪、长续航、佩戴舒适",
    "saleCountry": "US",
    "targetLanguage": "English",
    "duration": 15
}

视频复刻提示词请求示例(type=89时)

JSON
{
    "type": 89,
    "refVideoUrl": "https://example.com/reference-video.mp4",
    "imageUrlList": [
        "https://example.com/product-image-1.jpg",
        "https://example.com/product-image-2.jpg"
    ],
    "keyword": "商品名称:无线蓝牙耳机;卖点:降噪、长续航、佩戴舒适",
    "saleCountry": "US",
    "targetLanguage": "English",
    "duration": 15
}

响应体

顶层 code 始终为 JSON number(整数),成功返回 200,失败返回数字错误码,包括 5004(无效参数)、5007(字段校验失败)。客户端统一按数字解析,例如 code === 200;请求成功后仍需查询 data.status 判断任务是否完成。

traceIdstring
链路ID
codeinteger
状态码 200 为成功 其他为失败
msgstring
成功/错误描述
msgKeystring
错误描述编码,状态码不等于200时存在
dataobject
对象字段
idinteger
任务id

响应示例

JSON
{
  "traceId": "f6e0fe4f360f78445c2c5d52f2414dea",
  "code": 200,
  "msg": "成功",
  "data": {
    "id": 123456
  }
}

查询分析结果

POST/v2/process/result/imageToPrompt/infoapplication/json

请求体

idstring必填
任务id

请求示例

JSON
{
  "id": "1930923414987821056"
}

响应体

顶层 code 始终为 JSON number(整数),成功返回 200,失败返回数字错误码,包括 5004(无效参数)、5007(字段校验失败)。客户端统一按数字解析,例如 code === 200;请求成功后仍需查询 data.status 判断任务是否完成。

traceIdstring
链路ID
codeinteger
状态码 200 为成功 其他为失败
msgstring
成功/错误描述
msgKeystring
错误描述编码,状态码不等于200时存在
dataobject
对象字段
idstring
任务id
statusstring
状态
1.已创建 2.执行中 3.成功 4.失败.
resultobject
结果
对象字段
contentstring
内容

响应示例

JSON
{
  "traceId": "f6e0fe4f360f78445c2c5d52f2414dea",
  "code": 200,
  "msg": "成功",
  "data": {
    "id": "123",
    "type": 2,
    "status": 3,
    "result": {
      "content": "swimming pool, mother and baby, baby swimming, water splashes, family bonding, aquatic setting, blue water, blurred faces, close-up composition, indoor pool, parenting, mother-child interaction, wet hair, playful mood, natural lighting, infant safety, soft focus, casual attire, recreational activity, poolside."
    }
  }
}

商品信息分析

根据商品图片和可选文字描述提取商品信息,返回完整商品 JSON,适合为后续内容生成准备商品资料。

本接口使用 images、productText,提交后用下方的专用查询接口获取结果。同页「描述词分析」使用 type、imageUrlList、keyword,两类任务的编号和查询接口不能混用。

创建和查询响应的顶层 code 始终为 JSON number(整数):成功返回 200,失败返回数字错误码,包括 5004(无效参数)、5007(字段校验失败)。与描述词分析接口使用同一类型口径,客户端统一按数字解析,例如 code === 200。

创建任务

POST/image/v2/make/productInfoAnalysisapplication/json

请求体

imagesarray[string]必填
商品图片 URL 列表,至少 1 张、最多 30 张。图片地址须在任务执行期间可访问。
productTextstring可选
补充商品名称、卖点或其它商品说明,帮助分析图片。

请求示例

JSON
{
  "images": [
    "https://example.com/product-front.jpg",
    "https://example.com/product-detail.jpg"
  ],
  "productText": "无线蓝牙耳机,主打降噪、长续航和舒适佩戴"
}

提交后返回什么

data.id 是字符串任务编号,请保存它并查询原任务。code=200 表示请求成功,data.status=2 表示任务仍在分析中。

JSON
{
  "code": 200,
  "msg": "成功",
  "data": {
    "id": "123456789",
    "type": 24,
    "status": 2
  }
}

查询分析结果

POST/image/v2/make/productInfoAnalysis/infoapplication/json

使用与创建任务相同的身份查询,仅允许任务所属团队及用户读取。

请求体

idstring必填
创建商品信息分析任务返回的 data.id,不可为空或仅包含空白字符。

请求示例

JSON
{
  "id": "123456789"
}

返回字段

codeinteger
请求结果码,200 表示请求成功,其它数字表示失败。任务执行状态另看 data.status。
data.idstring
商品信息分析任务编号。
data.typeinteger
任务类型,固定为 24,无需作为请求参数传入。
data.statusinteger
2 分析中、3 成功、4 失败。
data.result.productJsonstring
成功时返回完整商品 JSON 字符串,可用 JSON.parse 解析;内容可为对象或数组。
data.result.textstring
与 productJson 相同的完整 JSON 字符串,读取任一字段即可。
data.errorstring
失败原因,status=4 时查看。

查询结果示例

以下商品内容仅作示例,实际 JSON 字段以分析结果为准。

JSON
{
  "code": 200,
  "msg": "成功",
  "data": {
    "id": "123456789",
    "type": 24,
    "status": 3,
    "result": {
      "productJson": "{\"name\":\"无线蓝牙耳机\",\"features\":[\"降噪\",\"长续航\"]}",
      "text": "{\"name\":\"无线蓝牙耳机\",\"features\":[\"降噪\",\"长续航\"]}"
    }
  }
}

建议每隔 2~3 秒查询一次,直到 status=3 或 4;客户端等待超时不代表任务失败,请保留任务编号并继续查询原任务,避免重复创建。

请及时查询并保存结果。执行超时的任务会被标记为失败;任务不存在时,查询返回 status=4,error 为“异步任务超时或不存在”。

补充知识:商品分析字段映射

当商品分析结果包含 data.result.productJson 时,可按本节规则将结构化 JSON 转成 [中文标签]:内容 的多行文本。本节是展示层的补充约定,不改变接口返回结构,也不适用于所有 AI 分析结果;只返回 data.result.content 的结果仍按原格式读取。

解析与展示规则

  1. 先确认接口响应成功且 data.status=3,再读取 data.result;创建成功或执行中不代表已有分析结果。
  2. productJson 是 JSON 字符串,需要在解析外层响应后再解析一次,不要手动替换引号或反斜杠。未返回或为空时,可读取同层 text;商品分析结果中的 text 同样是原始 JSON 字符串,不是已经排版的展示文本。两者择一解析,不要重复拼接。
  3. 下表路径均相对于二次解析后的商品对象,例如 productInfo.product_name,不是外层响应的直接字段。仅对对象结构使用这组映射;如果结果为数组或其他结构,保留原始结果,按对应结构另行处理,不强制转成对象。
  4. 按表中顺序输出,每行使用 [标签]:内容,行间使用换行符 \n,不依赖 JSON 字段自身的排列顺序。字段缺失、null 或去除首尾空白后为空时跳过,不输出 null、空标签行或自行补全的内容。
  5. visibleDetails 是字符串数组:按原顺序保留非空项,用中文分号 ; 连接,不输出 JSON 的方括号、引号。其余映射字段按字符串读取,保留原有标点。
  6. productInfo.target_audience 与 product_text.target_audience 不混用;visualProfile.model_appearance 对应“模特形象”,顶层 person_anchor 对应“模特描述”,分别展示。
  7. 本表只选取用于商品信息展示的 25 项字段,不是完整结果 schema。保留原始 JSON;riskNotes、conflictNotes、forbiddenMixing、shotPlan、moduleFields 等未列字段不并入这段展示文本,但不应从原始结果删除。图片推断出的材质、尺码等信息仍须人工核实,不视为真实商品参数承诺。

字段映射表

顺序展示标签商品对象中的字段路径值格式
1商品名称productInfo.product_name字符串
2核心卖点productInfo.main_selling_point字符串
3商品类型visualProfile.product_type字符串
4风格关键词visualProfile.style_keywords字符串
5产品类目productInfo.category_path字符串
6卖点描述productInfo.selling_points_description字符串
7配色方案visualProfile.color_scheme字符串
8材质质感visualProfile.material_texture字符串
9目标受众productInfo.target_audience字符串
10使用场景productInfo.use_case字符串
11次要卖点productInfo.secondary_selling_points字符串
12工艺细节productInfo.craftsmanship_details字符串
13使用方式productInfo.usage_method字符串
14版型结构visualProfile.structure_shape字符串
15尺码印象visualProfile.size_impression字符串
16视觉亮点visualProfile.visual_highlights字符串
17模特形象visualProfile.model_appearance字符串
18场景描述visualProfile.scene_description字符串
19Logo描述visualProfile.logo_description字符串
20正面特征visualProfile.front_top_features字符串
21背面特征visualProfile.back_bottom_features字符串
22可见细节visibleDetails字符串数组,用 ; 连接
23模特描述person_anchor字符串
24商品锚点productAnchor字符串
25来源说明sourceTextHandling字符串

转换示例

以下为裁剪后的商品分析响应,仅保留部分字段演示二次解析和输出;实际返回的其他字段应继续保留。

JSON
{
  "code": 200,
  "data": {
    "status": 3,
    "result": {
      "productJson": "{\"productInfo\":{\"product_name\":\"碎花吊带连衣短裙搭配针织开衫\",\"main_selling_point\":\"清新蓝色小碎花印花与高腰显瘦A字版型,搭配温柔米白针织开衫\"},\"visualProfile\":{\"product_type\":\"女士连衣裙搭配针织开衫\"},\"visibleDetails\":[\"浅蓝色花草小碎花印花图案遍布裙身\",\"前胸微V领口及竖排小钮扣修饰\"],\"productAnchor\":\"浅蓝色碎花连衣短裙与米白色针织开衫\"}"
    }
  }
}

按映射规则转换后的文本如下;示例中未返回的字段不输出:

TEXT
[商品名称]:碎花吊带连衣短裙搭配针织开衫
[核心卖点]:清新蓝色小碎花印花与高腰显瘦A字版型,搭配温柔米白针织开衫
[商品类型]:女士连衣裙搭配针织开衫
[可见细节]:浅蓝色花草小碎花印花图案遍布裙身;前胸微V领口及竖排小钮扣修饰
[商品锚点]:浅蓝色碎花连衣短裙与米白色针织开衫

扣费标准

两类接口创建分析任务均为每次 20 点;查询分析结果不额外扣点。