Edit a proposal before approving it

curl --request PUT \
  --url https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "proposedTitle": "<string>",
  "proposedResponse": "<string>",
  "proposedChildren": [
    {
      "title": "<string>",
      "response": "<string>",
      "label": "<string>",
      "topic": "<string>"
    }
  ]
}
'

import requests

url = "https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id}"

payload = {
    "proposedTitle": "<string>",
    "proposedResponse": "<string>",
    "proposedChildren": [
        {
            "title": "<string>",
            "response": "<string>",
            "label": "<string>",
            "topic": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    proposedTitle: '<string>',
    proposedResponse: '<string>',
    proposedChildren: [
      {title: '<string>', response: '<string>', label: '<string>', topic: '<string>'}
    ]
  })
};

fetch('https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'proposedTitle' => '<string>',
    'proposedResponse' => '<string>',
    'proposedChildren' => [
        [
                'title' => '<string>',
                'response' => '<string>',
                'label' => '<string>',
                'topic' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id}"

	payload := strings.NewReader("{\n  \"proposedTitle\": \"<string>\",\n  \"proposedResponse\": \"<string>\",\n  \"proposedChildren\": [\n    {\n      \"title\": \"<string>\",\n      \"response\": \"<string>\",\n      \"label\": \"<string>\",\n      \"topic\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"proposedTitle\": \"<string>\",\n  \"proposedResponse\": \"<string>\",\n  \"proposedChildren\": [\n    {\n      \"title\": \"<string>\",\n      \"response\": \"<string>\",\n      \"label\": \"<string>\",\n      \"topic\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"proposedTitle\": \"<string>\",\n  \"proposedResponse\": \"<string>\",\n  \"proposedChildren\": [\n    {\n      \"title\": \"<string>\",\n      \"response\": \"<string>\",\n      \"label\": \"<string>\",\n      \"topic\": \"<string>\"\n    }\n  ]\n}"

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

{
  "entryId": "<string>",
  "analyzedTitle": "<string>",
  "analyzedResponse": "<string>",
  "diagnosis": {
    "resolution": {
      "score": 0.35,
      "reason": "<string>"
    },
    "actionability": {
      "score": 0.35,
      "reason": "<string>"
    },
    "clarity": {
      "score": 0.35,
      "reason": "<string>"
    },
    "composite": 0.42
  },
  "performance": {
    "timesUsed": 312,
    "retentionRatePct": 61.4,
    "csatPct": 72,
    "csatResponses": 38,
    "clarifiedPct": 12.5
  },
  "priority": "P1",
  "impactScore": 42,
  "estimatedTickets": 17.5,
  "duplicateCheck": {
    "status": "ok",
    "similar": [
      {
        "entryId": "<string>",
        "title": "<string>"
      }
    ],
    "note": "<string>"
  },
  "createdAt": "2026-08-10T14:32:05",
  "id": "6683f1c2a4b19e0012ab34cd",
  "proposedTitle": "<string>",
  "proposedResponse": "<string>",
  "proposedChildren": [
    {
      "title": "<string>",
      "response": "<string>",
      "label": "<string>",
      "topic": "<string>"
    }
  ],
  "recommendationSummary": "<string>",
  "recommendationDetails": "<string>",
  "finalText": "<string>",
  "clientNote": "<string>",
  "decidedBy": "<string>",
  "decidedAt": "2026-08-11T09:14:22",
  "driftDetected": false,
  "analysisPeriod": "2026-03-09 → 2026-04-07"
}

{
  "error": "Forbidden: token holds no claim for the requested account"
}

{
  "error": "Forbidden: token holds no claim for the requested account"
}

{
  "error": "Forbidden: token holds no claim for the requested account"
}

PUT

knowledge-bases

{kbId}

improvements

quality

{id}

Edit a proposal before approving it

curl --request PUT \
  --url https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "proposedTitle": "<string>",
  "proposedResponse": "<string>",
  "proposedChildren": [
    {
      "title": "<string>",
      "response": "<string>",
      "label": "<string>",
      "topic": "<string>"
    }
  ]
}
'

import requests

url = "https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id}"

payload = {
    "proposedTitle": "<string>",
    "proposedResponse": "<string>",
    "proposedChildren": [
        {
            "title": "<string>",
            "response": "<string>",
            "label": "<string>",
            "topic": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    proposedTitle: '<string>',
    proposedResponse: '<string>',
    proposedChildren: [
      {title: '<string>', response: '<string>', label: '<string>', topic: '<string>'}
    ]
  })
};

fetch('https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'proposedTitle' => '<string>',
    'proposedResponse' => '<string>',
    'proposedChildren' => [
        [
                'title' => '<string>',
                'response' => '<string>',
                'label' => '<string>',
                'topic' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id}"

	payload := strings.NewReader("{\n  \"proposedTitle\": \"<string>\",\n  \"proposedResponse\": \"<string>\",\n  \"proposedChildren\": [\n    {\n      \"title\": \"<string>\",\n      \"response\": \"<string>\",\n      \"label\": \"<string>\",\n      \"topic\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"proposedTitle\": \"<string>\",\n  \"proposedResponse\": \"<string>\",\n  \"proposedChildren\": [\n    {\n      \"title\": \"<string>\",\n      \"response\": \"<string>\",\n      \"label\": \"<string>\",\n      \"topic\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cloudhumans.com/claudia/v1/knowledge-bases/{kbId}/improvements/quality/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"proposedTitle\": \"<string>\",\n  \"proposedResponse\": \"<string>\",\n  \"proposedChildren\": [\n    {\n      \"title\": \"<string>\",\n      \"response\": \"<string>\",\n      \"label\": \"<string>\",\n      \"topic\": \"<string>\"\n    }\n  ]\n}"

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

{
  "entryId": "<string>",
  "analyzedTitle": "<string>",
  "analyzedResponse": "<string>",
  "diagnosis": {
    "resolution": {
      "score": 0.35,
      "reason": "<string>"
    },
    "actionability": {
      "score": 0.35,
      "reason": "<string>"
    },
    "clarity": {
      "score": 0.35,
      "reason": "<string>"
    },
    "composite": 0.42
  },
  "performance": {
    "timesUsed": 312,
    "retentionRatePct": 61.4,
    "csatPct": 72,
    "csatResponses": 38,
    "clarifiedPct": 12.5
  },
  "priority": "P1",
  "impactScore": 42,
  "estimatedTickets": 17.5,
  "duplicateCheck": {
    "status": "ok",
    "similar": [
      {
        "entryId": "<string>",
        "title": "<string>"
      }
    ],
    "note": "<string>"
  },
  "createdAt": "2026-08-10T14:32:05",
  "id": "6683f1c2a4b19e0012ab34cd",
  "proposedTitle": "<string>",
  "proposedResponse": "<string>",
  "proposedChildren": [
    {
      "title": "<string>",
      "response": "<string>",
      "label": "<string>",
      "topic": "<string>"
    }
  ],
  "recommendationSummary": "<string>",
  "recommendationDetails": "<string>",
  "finalText": "<string>",
  "clientNote": "<string>",
  "decidedBy": "<string>",
  "decidedAt": "2026-08-11T09:14:22",
  "driftDetected": false,
  "analysisPeriod": "2026-03-09 → 2026-04-07"
}

{
  "error": "Forbidden: token holds no claim for the requested account"
}

{
  "error": "Forbidden: token holds no claim for the requested account"
}

{
  "error": "Forbidden: token holds no claim for the requested account"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

kbId

string

required

Knowledge base to operate on. Get the ids from listMyKnowledgeBases.

string

required

Proposal to edit, as returned by listQualityProposals.

Body

application/json

New text for a proposal, before approving it.

proposedTitle

string

Replace the proposed question. Omit to leave it as proposed.

proposedResponse

string

Replace the proposed answer. Omit to leave it as proposed; it cannot be blanked out.

proposedChildren

object[]

Replace the split of a QUEBRAR proposal. Omit to leave it as proposed; it cannot be emptied.

Show child attributes

Response

The proposal as stored.

A rewrite proposed for content that is answering badly.

entryId

string

required

The content this proposal rewrites. Read it with getEntry.

action

enum<string>

required

What the proposal does to the content: REESCREVER and MELHORAR replace the answer, CORRIGIR_CONFIG also fixes the question, CONSOLIDAR and QUEBRAR restructure it and cannot be applied by this API yet.

Available options:

REESCREVER,

MELHORAR,

CONSOLIDAR,

QUEBRAR,

CORRIGIR_CONFIG

analyzedTitle

string

required

The question as it read when the content was analysed.

analyzedResponse

string

required

The answer as it read when the content was analysed. Compare it with the proposal to see what changes.

diagnosis

object

required

Why the content is being flagged.

Show child attributes

performance

object

required

How the content performed over the analysed window.

Show child attributes

priority

string

required

How urgent the fix is.

Example:

"P1"

impactScore

number<double>

required

Conversations per period this content could stop losing if it answered well — the theoretical ceiling.

Example:

42

estimatedTickets

number<double>

required

The realistic share of that ceiling, after how often the content is actually reached.

Example:

17.5

duplicateCheck

object

required

Whether the rewrite risks overlapping existing content.

Show child attributes

reviewState

enum<string>

required

Where the proposal stands in the review.

Available options:

PENDING,

APPROVED,

REJECTED

createdAt

string

required

When the proposal was raised (ISO-8601).

Example:

"2026-08-10T14:32:05"

string

Use this id to edit, approve or reject the proposal.

Example:

"6683f1c2a4b19e0012ab34cd"

proposedTitle

string

Proposed new question. Only CORRIGIR_CONFIG changes it.

proposedResponse

string

Proposed new answer — what approving will publish.

proposedChildren

object[]

For a QUEBRAR proposal, the entries the content would be split into.

Show child attributes

recommendationSummary

string

The change in one line.

recommendationDetails

string

The reasoning behind the change, at length.

clientDecision

enum<string>

The decision recorded when it was approved or rejected.

Available options:

APROVAR_SEM_ALTERACAO,

APROVAR_COM_AJUSTES,

REESCREVER_DO_ZERO,

REJEITAR

finalText

string

The text actually published on approval — the proposal, or your edit of it.

clientNote

string

The note recorded with the decision.

decidedBy

string

Who decided, taken from their credentials.

decidedAt

string

When it was decided (ISO-8601).

Example:

"2026-08-11T09:14:22"

driftDetected

boolean

True when the content changed after it was analysed, so the proposal was written against an older answer. False when the current answer still matches. Absent when the current answer could not be read, so drift is unknown — the proposal may be written against stale content. Review it before approving; it never blocks.

Example:

false

analysisPeriod

string

The window the performance figures cover.

Example:

"2026-03-09 → 2026-04-07"

Getting Started

Authentication

Knowledge Bases

Knowledge Base Content

Content Quality

Content Improvements

Content Sources

MCP Servers

Playground

Project Settings

Edit a proposal before approving it

Authorizations

Path Parameters

Body

Response