Skip to main content
POST
/
api
/
user
/
histories
Retrieve user conversation histories
curl --request POST \
  --url http://localhost:3000/api/user/histories \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "historyOnly": true,
  "limit": 5,
  "course_id": 1750532703472
}
'
{
  "success": true,
  "data": [
    {
      "id": "688b024f7db6fe6e921399e3",
      "in": {
        "input": "How are you?"
      },
      "out": {
        "outputs": [
          "I am doing wonderful, thank you for asking..."
        ]
      },
      "status": "active"
    }
  ]
}

Authorizations

​
x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
​
limit
integer

Maximum number of records to return

Example:

5

​
institution
string

Leave undefined to pull history records from the current user's institution, or specify to explicitely indicate which digital twin you want to retreive history records from

​
course_id
number

Course identifier to filter by

Example:

1750532703472

​
before
number

EPOCH date time ms to pull records before this date

Example:

1723019070274

​
after
number

EPOCH date time ms to pull records after this date

Example:

1723019070274

​
historyId
string

The ID of a specific history record to retrieve when specified

Example:

true

Response

Successfully retrieved conversation histories

​
success
boolean

Indicates if the request was successful

​
data
object[]

Array of history objects matching the search criteria

​
message
string

Error message when success is false