Skip to content
Bottle

Read your help conversation

GET
/help-chat/conversations/{id}
curl --request GET \
  --url https://example.com/help-chat/conversations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Conversation

Media typeapplication/json
object
id
required
string format: uuid
title
required
string
<= 100 characters
messages
required
Array<object>
<= 100 items
object
id
required
string format: uuid
role
required
string
Allowed values: user assistant
content
required
string
<= 16000 characters
sources
required
Array<object>
<= 3 items
object
id
required
string
>= 1 characters <= 200 characters
title
required
string
>= 1 characters <= 400 characters
url
required
string format: uri
<= 2048 characters
action
One of:
object
type
required
string
Allowed values: report_problem
draft
required
string
>= 1 characters <= 2000 characters
title
string
>= 1 characters <= 200 characters
urgency
string
Allowed values: stopping_work slowing_down question
page
object
route
required
string
<= 400 characters /^\/[\w:./-]*$/
createdAt
required
string format: date-time

Example 

{
  "messages": [
    {
      "role": "user",
      "action": {
        "type": "report_problem",
        "urgency": "stopping_work"
      }
    }
  ]
}

401

Section titled “401”

Sign in required

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Session and membership required

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Conversation not found

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

An answer is already running

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

429

Section titled “429”

Chat limit reached

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

503

Section titled “503”

Help chat unavailable

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}