Skip to Content

Save or clear feedback

POST
/api/v1/rewrites/{id}/feedback

Only completed, completed_with_warnings or needs_review jobs accept feedback. Sending feedback shares original text, output and note with Ink to improve and train its models. Text and notes expire after 90 days. Editing does not restart text retention. Clear with {"rating":null}, including without current terms. Only down accepts reasons. Notes allow at most 500 Unicode characters. Bodies allow at most 8,192 bytes. Feedback writes share 30 per minute per user.

Authorization

Bearer
headerAuthorizationBearer <token>

Ink API key from /app/api-keys.

Path Parameters

id*string
Formatuuid

Request Body

application/json
  1. body
rating*|null
reasons?array<>
Itemsitems <= 5
Default[]
note?string|null

Response Body

Saved or cleared feedback.

application/json
  1. response
feedback*|null
creditedWords*integer
Range0 <= value
note_retention_days*integer
eligibleForCredit?boolean
creditRequiresPaidPlan?boolean
Example Request
curl -X POST 'https://ink.ego.ist/api/v1/rewrites/497f6eca-6276-4993-bfeb-53cbbbba6f08/feedback' \
  -H 'Content-Type: application/json' \
  -d '{
  "rating": "up"
}'
Example Response
{
  "feedback": {
    "rating": "up",
    "reasons": [
      "string"
    ],
    "note": "string"
  },
  "creditedWords": 0,
  "note_retention_days": 90,
  "eligibleForCredit": true,
  "creditRequiresPaidPlan": true
}