OpenMax
免费试用

Apps API · Stars

Stars: 3 个接口

← 全部分组

GET /api/v1/stars

List my stars

权限(scope): org:me:read · 调用方式: appToken · operationId: list-stars

Required app scope: org:me:read.

Returns the current user's stars of one object type (knowledge_base, automation, agent, connector), newest first. Stars are private to the caller. Ids are not checked for existence or visibility: intersect them with the owning service's list. Projects use starred_by on list-projects instead. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
object_type query string 是 Object type to list: knowledge_base, automation, agent or connector. Validated by the platform; any other value is rejected with 400 WORK_INVALID_STAR_OBJECT_TYPE.

回包

DELETE /api/v1/stars/{object_type}/{object_id}

Unstar an object

权限(scope): org:me:write · 调用方式: appToken · operationId: unstar-object

Required app scope: org:me:write.

Removes the current user's star from a knowledge base, automation, agent or connector. Idempotent: unstarring an object that is not starred succeeds. No visibility check, so a stale star can always be cleared. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
object_type path string 是 Object type: knowledge_base, automation, agent or connector. Validated by the platform; any other value (including project) is rejected with 400 WORK_INVALID_STAR_OBJECT_TYPE.
object_id path string 是 Id of the object in its owning service, 1-128 characters without whitespace or control characters (else 400 WORK_INVALID_STAR_OBJECT_ID). Treated as opaque: existence and visibility are not checked.

回包

PUT /api/v1/stars/{object_type}/{object_id}

Star an object

权限(scope): org:me:write · 调用方式: appToken · operationId: star-object

Required app scope: org:me:write.

Stars a knowledge base, automation, agent or connector for the current user. Idempotent: re-starring succeeds and keeps the original created_at. A new star beyond the per-type cap (500) is rejected with 412 WORK_STAR_LIMIT_REACHED and meta.limit; the cap is soft (concurrent stars can overshoot). Existence and visibility of the object are not checked. Response wrapped in standard envelope.

参数

名字 位置 类型 必填 说明
object_type path string 是 Object type: knowledge_base, automation, agent or connector. Validated by the platform; any other value (including project) is rejected with 400 WORK_INVALID_STAR_OBJECT_TYPE.
object_id path string 是 Id of the object in its owning service, 1-128 characters without whitespace or control characters (else 400 WORK_INVALID_STAR_OBJECT_ID). Treated as opaque: existence and visibility are not checked.

回包