Rewrite an item's answer

POST

/api/v1/questionnaires/{questionnaire_id}/questionnaire_items/{id}/rewrite_answer

Synchronous. Rewrites the current answer, saves the result on the item and returns it. Consumes credits. To preview a rewrite without saving, use ai_enhance_answer instead.

Authorizations

bearerAuth

Path Parameters

NameType

questionnaire_id

required

string

Example

qu_1a2b

The questionnaire’s prefixed ID

required

string

The record’s prefixed ID

Responses

200

The item with its rewritten answer

Response body

application/json

object

string

web_link

string format: uri

question

string

answer

string | null

rationale

string | null

Why the answer was given

guidance

string | null

Guidance text supplied with the question

explanation

string | null

Markdown explanation of the question; see explain_question

explanation_formatted

string | null

explanation rendered as HTML

applicable

boolean | null

auto_answer

boolean

category

string | null

sub_category

string | null

state

string

Allowed values: new ready_to_answer references_fetched applicability_checked needs_input auto_answered approved

boolean_answer

string | null

Allowed values: yes no na

For yes/no questions

boolean_answer_human

string | null

Allowed values: Yes No N/A

confidence

string | null

0–1, encoded as a decimal string

confidence_as_percent

string | integer

Decimal string; 0 when there is no confidence

confidence_as_words

string

Allowed values: Excellent Very good Good Ok Low

confidence_rationale

string | null

requires_attention

boolean

attention_points

Array<string> | null

priority

integer | null

>= 1 <= 5

portal_markup

string | null

Answer formatted for pasting into a portal

sufficient_context

boolean | null

sufficient_context_response

string | null

Why the knowledge base was insufficient

created_at

string format: date-time

updated_at

string format: date-time

user

One of:

object
null

The member who owns or answered a record. id is the numeric database ID.

object

integer

name

string

email

string format: email

position

integer | null

1-based position in the questionnaire

total_questions

integer

references

Array<object>

A knowledge base item or source passage retrieved for an answer

object

integer

Numeric database ID

reference_type

string

Allowed values: KnowledgeBaseItem Embedding

reference_id

integer

Numeric database ID of the referenced record

relevance_score

number | null

<= 1

relevance_as_words

string

Allowed values: Excellent Very good Good Ok Low

distance

number | null

Vector distance from the question

search_method

string | null

Allowed values: vector keyword hybrid

cited_text

string | null

The passage quoted in the answer, when it was used

created_at

string format: date-time

reference

One of:

object
object

Present when reference_type is KnowledgeBaseItem

object

string

web_link

string format: uri

question

string

answer

string | null

state

string

Allowed values: new ready_to_answer applicability_checked references_fetched needs_input auto_answered approved

Present when reference_type is Embedding

object

string

text

string

The passage text

source_title

string | null

page

integer | null

Page of the source document

section

string | null

section_breadcrumb

string | null

Heading path to the section

403

Out of credits, or no active subscription (usage_blocked)

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

404

No such record in this account

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

422

There is no answer to rewrite, or the rewrite failed

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

Request

curl --request POST \
  --url https://app.responsehub.io/api/v1/questionnaires/qu_1a2b/questionnaire_items/example/rewrite_answer \
  --header 'Authorization: Bearer <token>'

require 'uri'
require 'net/http'

url = URI("https://app.responsehub.io/api/v1/questionnaires/qu_1a2b/questionnaire_items/example/rewrite_answer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.responsehub.io/api/v1/questionnaires/qu_1a2b/questionnaire_items/example/rewrite_answer', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();

const url = 'https://app.responsehub.io/api/v1/questionnaires/qu_1a2b/questionnaire_items/example/rewrite_answer';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://app.responsehub.io/api/v1/questionnaires/qu_1a2b/questionnaire_items/example/rewrite_answer"

  req, _ := http.NewRequest("POST", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

200example

Example^generated

{
  "id": "qi_1a2b",
  "web_link": "https://example.com",
  "question": "example",
  "answer": "example",
  "rationale": "example",
  "guidance": "example",
  "explanation": "example",
  "explanation_formatted": "example",
  "applicable": true,
  "auto_answer": true,
  "category": "example",
  "sub_category": "example",
  "state": "new",
  "boolean_answer": "yes",
  "boolean_answer_human": "Yes",
  "confidence": "0.85",
  "confidence_as_percent": "85.0",
  "confidence_as_words": "Excellent",
  "confidence_rationale": "example",
  "requires_attention": true,
  "attention_points": [
    "example"
  ],
  "priority": 1,
  "portal_markup": "example",
  "sufficient_context": true,
  "sufficient_context_response": "example",
  "created_at": "2026-04-15T12:00:00Z",
  "updated_at": "2026-04-15T12:00:00Z",
  "user": {
    "id": 1,
    "name": "example",
    "email": "hello@example.com"
  },
  "position": 1,
  "total_questions": 1,
  "references": [
    {
      "id": 1,
      "reference_type": "KnowledgeBaseItem",
      "reference_id": 1,
      "relevance_score": 1,
      "relevance_as_words": "Excellent",
      "distance": 1,
      "search_method": "vector",
      "cited_text": "example",
      "created_at": "2026-04-15T12:00:00Z",
      "reference": {
        "id": "kbi_1a2b",
        "web_link": "https://example.com",
        "question": "example",
        "answer": "example",
        "state": "new"
      }
    }
  ]
}

403example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

404example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

422example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}