Thrixel API

Ratings & Favorites

Thumbs up/down ratings and personal favorites for submissions.

There are two ways to register that you liked (or didn't like) a submission:

  • Ratings — a thumbs-up / thumbs-down signal. Thrixel uses these in aggregate to evaluate model quality. One rating per API key per submission; re-calling flips the value.
  • Favorites — a personal bookmark. Surfaces the submission in your "Favorite Assets" view. Independent of ratings (so you can love a model for personal reasons even while thumbs-downing it for the quality signal).

Both are scoped to your API key — nothing here is public.

Ratings


Set a rating

PUT /api/v1/{submission_id}/rating

Requires API key.

Upserts the rating for the calling API key on this submission. Re-calling with a different value flips the rating; the response always reflects the current state.

Path Parameters

NameTypeDescription
submission_idstring (required)UUID of the submission.

Request Body

NameTypeDescription
ratinginteger (required)1 for thumbs-up, -1 for thumbs-down.

Example Request

curl -X PUT https://api.thrixel.com/api/v1/$SUBMISSION_ID/rating \
  -H "Authorization: Bearer sk-thrixel-<YOUR_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"rating": 1}'

Example Response

{
  "submission_id": "sub-3c4d...",
  "rating": 1
}

Errors

CodeMeaning
404Submission not found.
422rating is not 1 or -1.

Clear a rating

DELETE /api/v1/{submission_id}/rating

Requires API key.

Removes the calling API key's rating on this submission. Idempotent — no error if no rating exists. The response has rating: null.

Path Parameters

NameTypeDescription
submission_idstring (required)UUID of the submission.

Example Response

{
  "submission_id": "sub-3c4d...",
  "rating": null
}

Favorites


Distinct from ratings

Favorites are a personal collection — they don't affect Thrixel's internal quality signal. Use them to bookmark models you want to find later in the "Favorite Assets" sidebar view.

Favorite a submission

PATCH /api/v1/{submission_id}/favorite

Requires API key.

Path Parameters

NameTypeDescription
submission_idstring (required)UUID of the submission.

Request Body

NameTypeDescription
is_favoriteboolean (required)true to favorite, false to remove.

Example Request

curl -X PATCH https://api.thrixel.com/api/v1/$SUBMISSION_ID/favorite \
  -H "Authorization: Bearer sk-thrixel-<YOUR_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"is_favorite": true}'

Example Response

{
  "submission_id": "sub-3c4d...",
  "is_favorite": true
}

Pin a favorite

PATCH /api/v1/{submission_id}/favorite-pin

Requires API key.

Pin or unpin a favorited submission so it sorts to the top of the Favorite Assets grid. Independent of the chat-sidebar pin (PATCH /pin in Organize) — pinning here only affects the favorites view.

The submission must already be a favorite (i.e. is_favorite=true) for pinning to have a visible effect.

Path Parameters

NameTypeDescription
submission_idstring (required)UUID of the submission.

Request Body

NameTypeDescription
is_favorite_pinnedboolean (required)true to pin within favorites, false to unpin.

Example Response

{
  "submission_id": "sub-3c4d...",
  "is_favorite_pinned": true
}

On this page