Apps API · Stars
Stars: 3 endpoints
GET /api/v1/stars
List my stars
Scope: org:me:read · Called with: 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.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
object_type |
query | string | yes | 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. |
Responses
200OK —application/json·DataResponseStarListBodydefaultError —application/problem+json·D8Error
DELETE /api/v1/stars/{object_type}/{object_id}
Unstar an object
Scope: org:me:write · Called with: 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.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
object_type |
path | string | yes | 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 | yes | 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. |
Responses
200OK —application/json·DataResponseStruct {}BodydefaultError —application/problem+json·D8Error
PUT /api/v1/stars/{object_type}/{object_id}
Star an object
Scope: org:me:write · Called with: 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.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
object_type |
path | string | yes | 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 | yes | 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. |
Responses
200OK —application/json·DataResponseStruct {}BodydefaultError —application/problem+json·D8Error
