Completions
Tune Studio
- Assistants
- Model
- Finetuning
- Logs
- User
- Studio
- Thread Datasets
- POSTCreate thread dataset
- POSTList thread datasets
- POSTGet thread dataset
- POSTUpdate thread dataset
- POSTDelete a thread dataset
- POSTAdd threads to a dataset
- POSTRemove threads from a dataset
- POSTReplace thread messages
- POSTCreate and save a thread in a dataset
- POSTList threads in a dataset
- POSTList messages in threads in a dataset
- POSTExport a thread dataset
- POST
- Runs
- Run Steps
- Threads
- Messages
List messages in threads in a dataset
List messages in threads in a dataset.
curl --request POST \
--url https://studio.tune.app/tune.dataset.ThreadDatasetService/ListThreadDatasetThreadsMessages \
--header 'Content-Type: application/json' \
--header 'X-Tune-Key: <api-key>' \
--data '{
"auth": {
"organization": "<string>",
"cluster": "<string>"
},
"datasetId": "<string>",
"page": {
"limit": 123,
"prevPageToken": "<string>",
"nextPageToken": "<string>",
"totalPage": 123
},
"order": "<string>"
}'
{
"threadsMessages": [
{
"threadId": "<string>",
"messages": [
{
"id": "<string>",
"object": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"threadId": "<string>",
"role": "<string>",
"content": [
{
"type": "<string>",
"text": "<string>",
"imageFile": {
"fileId": "<string>",
"detail": "<string>"
},
"imageUrl": {
"url": "<string>",
"detail": "<string>"
}
}
],
"attachments": [
{
"fileId": "<string>",
"tools": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {},
"required": [
"<string>"
]
},
"openapiSpec": "<string>",
"openapiActionData": {}
}
]
}
],
"assistantId": "<string>",
"runId": "<string>",
"metadata": {}
}
],
"createdAt": "2023-11-07T05:31:56Z"
}
],
"page": {
"limit": 123,
"prevPageToken": "<string>",
"nextPageToken": "<string>",
"totalPage": 123
}
}
Authorizations
Tune API Keys are the preferred way to authenticate with the API. You can create an API Key from your Tune Studio Profile → 'Access Keys' (in sidebar)
Body
The ID of dataset.
Order of the threads in dataset (default: created_at asc).
Response
List of threads with messages.
The ID of thread.
List of messages in thread.
The ID of the message.
"thread.message".
The time the message was created.
The ID of the thread the message is associated with.
"user" or "assistant".
The content of the message.
"text" or "image_file".
only used if type is "text".
The attachments of the message.
The ID of the file.
The tool that created the file.
The action data of the function.
The ID of the run that created the message.
Metadata for the message key-value pairs.
The time at which the thread was created.
Was this page helpful?
curl --request POST \
--url https://studio.tune.app/tune.dataset.ThreadDatasetService/ListThreadDatasetThreadsMessages \
--header 'Content-Type: application/json' \
--header 'X-Tune-Key: <api-key>' \
--data '{
"auth": {
"organization": "<string>",
"cluster": "<string>"
},
"datasetId": "<string>",
"page": {
"limit": 123,
"prevPageToken": "<string>",
"nextPageToken": "<string>",
"totalPage": 123
},
"order": "<string>"
}'
{
"threadsMessages": [
{
"threadId": "<string>",
"messages": [
{
"id": "<string>",
"object": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"threadId": "<string>",
"role": "<string>",
"content": [
{
"type": "<string>",
"text": "<string>",
"imageFile": {
"fileId": "<string>",
"detail": "<string>"
},
"imageUrl": {
"url": "<string>",
"detail": "<string>"
}
}
],
"attachments": [
{
"fileId": "<string>",
"tools": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {},
"required": [
"<string>"
]
},
"openapiSpec": "<string>",
"openapiActionData": {}
}
]
}
],
"assistantId": "<string>",
"runId": "<string>",
"metadata": {}
}
],
"createdAt": "2023-11-07T05:31:56Z"
}
],
"page": {
"limit": 123,
"prevPageToken": "<string>",
"nextPageToken": "<string>",
"totalPage": 123
}
}