Where a chat's workflow stands
curl --request GET \
--url https://api.example.com/api/chat/threads/{thread_id}/workflow \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/chat/threads/{thread_id}/workflow"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/chat/threads/{thread_id}/workflow', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/chat/threads/{thread_id}/workflow",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/chat/threads/{thread_id}/workflow"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/chat/threads/{thread_id}/workflow")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/chat/threads/{thread_id}/workflow")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"total": 123,
"version": "<string>",
"transcript": [
{
"key": "<string>",
"question": "<string>",
"answer": "<string>"
}
],
"current": {
"key": "<string>",
"text": "<string>",
"type": "choice",
"allow_other": true,
"required": true,
"number": 123,
"choices": [
"<string>"
],
"placeholder": "<string>"
},
"done": false,
"task": "<string>",
"available": true,
"can_continue": true
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}Chat
Where a chat's workflow stands
The questions asked and answered so far, the one waiting, and once every question is behind it the task to send. 404 when the chat wasn’t started from a workflow.
GET
/
api
/
chat
/
threads
/
{thread_id}
/
workflow
Where a chat's workflow stands
curl --request GET \
--url https://api.example.com/api/chat/threads/{thread_id}/workflow \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/chat/threads/{thread_id}/workflow"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/chat/threads/{thread_id}/workflow', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/chat/threads/{thread_id}/workflow",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/chat/threads/{thread_id}/workflow"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/chat/threads/{thread_id}/workflow")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/chat/threads/{thread_id}/workflow")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"total": 123,
"version": "<string>",
"transcript": [
{
"key": "<string>",
"question": "<string>",
"answer": "<string>"
}
],
"current": {
"key": "<string>",
"text": "<string>",
"type": "choice",
"allow_other": true,
"required": true,
"number": 123,
"choices": [
"<string>"
],
"placeholder": "<string>"
},
"done": false,
"task": "<string>",
"available": true,
"can_continue": true
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}Authorizations
OAuth2AuthorizationCodeBearerAPIKeyHeader
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Response
Successful Response
Where a workflow conversation stands.
Questions the workflow can ask.
The version it follows.
Show child attributes
Show child attributes
The question waiting for an answer; null once done.
Show child attributes
Show child attributes
Once done: the message to send to the assistant.
False when the version was withdrawn or is no longer yours to see.
Whether you may answer: who started it, or a manager.
Was this page helpful?

