Rate a finished run

/v1/executions/{id}/feedback

A thumb (scale: thumb, rating 1 or -1, the default) or one to five stars (scale: five; 4–5 count as up, 1–2 as down, 3 on no side), with an optional comment, on a run you made or whose agent you can read. One rating per run and rater: a second call changes it, rating: 0 takes it back. The rater is your account (api:<you>), or your customer with on_behalf_of (api:<you>:<id>). Ratings count in the agent’s numbers for the run’s day and version and show on the console’s Agents › Feedback.

Not yet described in the overlay (TI-20).

Authorizations

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer ozk_…. ozk_ platform API key (Authorization: Bearer ozk_…)

Path parameters

idstringrequired

Execution id (the x-execution-id of the run, or its engine id exec-…)

Query parameters

formatenum<string>

Response format; overrides Accept (an unknown value is 400 invalid_format)

Available options: json, yaml, markdown, text

Body

application/json
text/yaml

ratingintegerrequired

1 / -1 for thumb, 1–5 for five; 0 takes your rating back

Required range: -1 <= x <= 5

scaleenum<string>

Available options: thumb, five

Default: thumb

commentstring

Maximum string length: 2000

on_behalf_ofstring

Rate as your customer (the Agent Call door’s ids)

Minimum string length: 1 Maximum string length: 128

formatenum<string>

Available options: json, yaml, markdown, text

Response

Your rating was taken back (rating: 0) Response format negotiates via the format field, an Accept header (application/json, text/yaml, text/markdown, text/plain), or the request Content-Type mirror; default JSON.

application/json
text/yaml
text/markdown
text/plain

removedboolean

false when there was none

The rating as stored Response format negotiates via the format field, an Accept header (application/json, text/yaml, text/markdown, text/plain), or the request Content-Type mirror; default JSON.

application/json
text/yaml
text/markdown
text/plain

feedbackobject

Show child attributes

idstring

execution_idstring

agent_idstring

versioninteger

The agent version the run ran

scaleenum<string>

Available options: thumb, five

ratinginteger

sideenum<string> | null

Available options: up, down, null

commentstring | null

created_atstring

Format: date-time

updated_atstring

Format: date-time

invalid_feedback — rating must be 1 or -1 for thumb, 1 to 5 for five; comment at most 2000 characters; invalid_on_behalf_of — not a valid customer id; invalid_format / invalid_json / invalid_yaml — unreadable body or unknown format

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

unauthorized — missing, invalid or revoked ozk_ key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

execution_not_found — no execution with that id for this key (a foreign id answers the same); not_found — no route for this method on this path: every other method answers it

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

execution_running — the run has not finished; rate it once it has

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

upstream_error — a store failed; no detail is returned, retry shortly

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

import os import requests response = requests.post( "https://api.plungeai.com/v1/executions/{id}/feedback", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, json={ "rating": 0, }, ) if not response.ok: raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}") print(response.json())

const response = await fetch('https://api.plungeai.com/v1/executions/{id}/feedback', { method: 'POST', headers: { Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ "rating": 0 }), }) if (!response.ok) throw new Error(`${response.status} ${response.headers.get('X-Error-Code')}`) console.log(await response.json())

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Main { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.plungeai.com/v1/executions/{id}/feedback")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString("{\"rating\":0}")) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); if (response.statusCode() >= 400) { System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse("")); return; } System.out.println(response.body()); } }

{ "feedback": { "id": "<string>", "execution_id": "<string>", "agent_id": "<string>", "version": 0, "scale": "thumb", "rating": 0, "side": "up", "comment": "<string>", "created_at": "<string>", "updated_at": "<string>" } }