Report an assistant conversation. - RevoEngine

POST

/

api

/

v1

/

assistant

/

threads

/

{id}

/

report

Report an assistant conversation.

curl --request POST \
  --url https://api.revoengine.com/api/v1/assistant/threads/{id}/report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "The assistant assumed the wrong tenant and edited the wrong configuration.",
  "summary": "The assistant assumed the wrong tenant and edited the wrong configuration.",
  "assistantMessageId": "11111111-1111-4111-8111-111111111111"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    reason: 'The assistant assumed the wrong tenant and edited the wrong configuration.',
    summary: 'The assistant assumed the wrong tenant and edited the wrong configuration.',
    assistantMessageId: '11111111-1111-4111-8111-111111111111'
  })
};

fetch('https://api.revoengine.com/api/v1/assistant/threads/{id}/report', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revoengine.com/api/v1/assistant/threads/{id}/report"

payload = {
    "reason": "The assistant assumed the wrong tenant and edited the wrong configuration.",
    "summary": "The assistant assumed the wrong tenant and edited the wrong configuration.",
    "assistantMessageId": "11111111-1111-4111-8111-111111111111"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assistantThreadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Bearer JWT token or API Key (sk-*).

Path Parameters

id

string

required

Body

application/json

reason

string

User-provided reason describing what went wrong, such as wrong assumptions, model errors, or unexpected behavior.

Maximum string length: 1000

Example:

"The assistant assumed the wrong tenant and edited the wrong configuration."

summary

string

deprecated

Deprecated compatibility alias for reason. New clients must send reason.

Maximum string length: 1000

Example:

"The assistant assumed the wrong tenant and edited the wrong configuration."

assistantMessageId

string<uuid>

Optional message where the reported issue occurred. Must belong to the conversation.

Example:

"11111111-1111-4111-8111-111111111111"

Response

Conversation feedback accepted. Returns the report identifier, conversation identifier, pending status and creation time.

reportId

string<uuid>

required

Unique conversation report identifier.

assistantThreadId

string<uuid>

required

status

enum<string>

required

Available options:

pending,

exported

createdAt

string<date-time>

required

Report an assistant conversation.

curl --request POST \
  --url https://api.revoengine.com/api/v1/assistant/threads/{id}/report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "The assistant assumed the wrong tenant and edited the wrong configuration.",
  "summary": "The assistant assumed the wrong tenant and edited the wrong configuration.",
  "assistantMessageId": "11111111-1111-4111-8111-111111111111"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    reason: 'The assistant assumed the wrong tenant and edited the wrong configuration.',
    summary: 'The assistant assumed the wrong tenant and edited the wrong configuration.',
    assistantMessageId: '11111111-1111-4111-8111-111111111111'
  })
};

fetch('https://api.revoengine.com/api/v1/assistant/threads/{id}/report', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revoengine.com/api/v1/assistant/threads/{id}/report"

payload = {
    "reason": "The assistant assumed the wrong tenant and edited the wrong configuration.",
    "summary": "The assistant assumed the wrong tenant and edited the wrong configuration.",
    "assistantMessageId": "11111111-1111-4111-8111-111111111111"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assistantThreadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "createdAt": "2023-11-07T05:31:56Z"
}