# Get feedback

`GET /api/v1/rewrites/{id}/feedback`

## Authentication

Bearer API key. A paid plan after trial and current terms are required, except when clearing feedback.

## Parameters

```json
[
  {
    "name": "id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
]
```

## Responses

### HTTP 200

Owned job feedback and credit eligibility.

```json
{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "feedback",
          "creditedWords",
          "note_retention_days"
        ],
        "properties": {
          "feedback": {
            "anyOf": [
              {
                "type": "object",
                "required": [
                  "rating",
                  "reasons",
                  "note"
                ],
                "properties": {
                  "rating": {
                    "enum": [
                      "up",
                      "down"
                    ]
                  },
                  "reasons": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "note": {
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "creditedWords": {
            "type": "integer",
            "minimum": 0
          },
          "note_retention_days": {
            "type": "integer",
            "const": 90
          },
          "eligibleForCredit": {
            "type": "boolean"
          },
          "creditRequiresPaidPlan": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
```

### HTTP 400

Missing Idempotency-Key or invalid JSON. invalid_input also uses 400 for lock edits and target word budget errors.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 401

unauthorized: A valid API key is required.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 402

paid_plan_required: API keys require a paid subscription. Trials do not qualify.

setup_required: Choose an Ink plan to rewrite.

quota_exceeded: This rewrite exceeds your remaining word allowance.

payment_past_due: Your last payment failed. Update your card in Billing.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 403

terms_required: Accept Ink terms to continue.

forbidden_origin: This request must come from Ink.

permission_required: Passport permission is required to use this voice. Review access or delete the adapter.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 404

not_found: Rewrite not found.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 405

method_not_allowed: This method is not allowed for this endpoint.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 409

idempotency_conflict: This Idempotency-Key was already used with different text or settings.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 413

text_too_long: This text exceeds the request limit.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 422

unknown_field: Remove the unknown field.

invalid_input: Enter text and choose valid rewrite settings.

input_too_long: This text exceeds the request limit.

training_in_progress: This voice profile is still training.

insufficient_samples: This voice profile needs approved samples and an active adapter.

output_unreliable: This draft did not rewrite reliably, so we stopped. Your words were not used. Try a shorter section.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 429

key_cap_exceeded: This rewrite exceeds this API key's monthly word cap.

rate_limited: Too many rewrite requests. Try again later.

daily_ceiling_exceeded: The daily safety limit has been reached. Try again after 00:00 UTC.

```json
{
  "headers": {
    "Retry-After": {
      "description": "Seconds until retry, when supplied.",
      "schema": {
        "type": "string"
      }
    },
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```

### HTTP 503

tool_unavailable: Writing from a prompt is unavailable right now.

model_unavailable: The model is starting or unavailable. Try again shortly.

model_rejected: The model could not process this rewrite.

pinned_adapter_unavailable: The model version pinned to this rewrite is unavailable. Start a new rewrite.

```json
{
  "headers": {
    "Location": {
      "description": "Poll this job URL with the same Bearer key.",
      "schema": {
        "type": "string"
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "idempotency_key_required",
                  "invalid_json",
                  "unauthorized",
                  "paid_plan_required",
                  "setup_required",
                  "quota_exceeded",
                  "payment_past_due",
                  "terms_required",
                  "forbidden_origin",
                  "permission_required",
                  "not_found",
                  "method_not_allowed",
                  "idempotency_conflict",
                  "text_too_long",
                  "unknown_field",
                  "invalid_input",
                  "input_too_long",
                  "training_in_progress",
                  "insufficient_samples",
                  "output_unreliable",
                  "key_cap_exceeded",
                  "rate_limited",
                  "daily_ceiling_exceeded",
                  "tool_unavailable",
                  "model_unavailable",
                  "model_rejected",
                  "pinned_adapter_unavailable"
                ]
              },
              "message": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "action_url": {
                "type": "string",
                "format": "uri"
              },
              "hint": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
```
