Skip to main content
GET
/
v1
/
threads
/
{thread_id}
/
messages
List Thread Messages Handler
curl --request GET \
  --url http://localhost:8000/v1/threads/{thread_id}/messages
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sequence": 123,
      "content": {
        "text": "<string>",
        "is_error": true,
        "citations": [
          {
            "chunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quote": "<string>",
            "start_char": 1,
            "length": 123,
            "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "document_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "document_name": "<string>",
            "version_number": 123,
            "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "materialized_path": "<string>"
          }
        ],
        "references": [
          {
            "ref_type": "<string>",
            "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "display_name": "<string>",
            "materialized_path": "<string>"
          }
        ]
      },
      "parent_path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "materialized_path": "<string>",
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "details": {
        "steps": [
          {
            "id": "<string>",
            "name": "<string>",
            "start_time": "2023-11-07T05:31:56Z",
            "args": "<string>",
            "detail": "<string>",
            "end_time": "2023-11-07T05:31:56Z",
            "steps": "<array>"
          }
        ]
      }
    }
  ],
  "total": 1,
  "limit": 2,
  "offset": 1
}

Headers

​
authorization
string | null

Path Parameters

​
thread_id
string<uuid>
required

Query Parameters

​
before
string<date-time> | null

Cursor for keyset pagination: only return messages with created_at < this value

​
with_details
boolean
default:true

Include execution steps in response (default true)

​
limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of items to skip

Required range: x >= 0

Cookies

​
ks_uat
string | null

Response

Successful Response

​
items
ThreadMessageResponse · object[]
required

List of items

​
total
integer
required

Total number of items

Required range: x >= 0
​
limit
integer
required

Number of items per page

Required range: x >= 1
​
offset
integer
required

Number of items to skip

Required range: x >= 0