Skip to main content
POST
Rate an outcome
Records a 1-5 rating, with optional notes (at most 2,000 characters), on an outcome, as Console’s rating card does. A repeat overwrites the rating. When the outcome has a Judge verdict, the rating is also recorded as an operator override of that verdict; overrideAction says whether it agreed (agree), overruled it (disagree_overruled) or was the mixed 3-star signal (partial_agreement), and is null when no verdict is linked.

Who may rate

  • You need workflows:use at the home of the workflow that produced the outcome. Otherwise, and for a missing or malformed id, the answer is 404 “Outcome not found”.
  • You must be the workflow’s owner: its principal person (through that person’s Personal key) or the External App that created it. Otherwise your scopes must reach platform:manage (an elevated scope) and your role grants must hold it at the platform scope (403 naming it).
  • The rating is recorded as you: a Personal key’s owner, else the app or key.

Idempotency

With an Idempotency-Key, a repeat with the same key and body within 24 hours returns the recorded 200 only while you may still rate that outcome; otherwise 409 idempotency_result_unavailable. The rating is never written twice for one key.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key.

Required string length: 1 - 255

Path Parameters

outcomeId
string
required

The outcome to rate.

Minimum string length: 1

Body

application/json
rating
enum<number>
required

1 (failed) to 5 (great); 3 is a mixed signal.

Available options:
1,
2,
3,
4,
5
notes
string

Why, at most 2,000 characters.

Maximum string length: 2000

Response

Success

data
object
required
meta
object
required