Get Chat Threads
curl --request GET \
--url http://localhost:8000/api/v1/chat/threads \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8000/api/v1/chat/threads"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8000/api/v1/chat/threads', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/api/v1/chat/threads",
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 := "http://localhost:8000/api/v1/chat/threads"
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("http://localhost:8000/api/v1/chat/threads")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/chat/threads")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"thread_id": "<string>",
"is_completed": true,
"date_added": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"extra_data": {},
"google_ads_customer": {
"id": 123,
"date_added": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z",
"descriptive_name": "<string>",
"currency_code": "<string>",
"time_zone": "<string>",
"status": "<string>",
"manager": true,
"is_active": true,
"is_deleted": false
},
"google_ads_login_customer_id": 123,
"google_business_location": {
"id": "<string>",
"title": "<string>",
"store_code": "<string>",
"maps_uri": "<string>",
"storefront_address": {
"region_code": "<string>",
"language_code": "<string>",
"postal_code": "<string>",
"administrative_area": "<string>",
"locality": "<string>",
"sublocality": "<string>",
"address_lines": [
"<string>"
]
}
},
"assistant": {
"id": "<string>",
"assistant_type": "onboarding",
"date_added": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z"
}
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Chat
Get Chat Threads
Get the list of chat threads.
Args: company_id (int): Cattix Company ID assistant_type (AssistantType | None): The type of the chat thread (optional) user (User): The current user
Returns: Dict containing the list of chat threads
GET
/
api
/
v1
/
chat
/
threads
Get Chat Threads
curl --request GET \
--url http://localhost:8000/api/v1/chat/threads \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8000/api/v1/chat/threads"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8000/api/v1/chat/threads', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/api/v1/chat/threads",
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 := "http://localhost:8000/api/v1/chat/threads"
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("http://localhost:8000/api/v1/chat/threads")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/chat/threads")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"thread_id": "<string>",
"is_completed": true,
"date_added": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"description": "<string>",
"extra_data": {},
"google_ads_customer": {
"id": 123,
"date_added": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z",
"descriptive_name": "<string>",
"currency_code": "<string>",
"time_zone": "<string>",
"status": "<string>",
"manager": true,
"is_active": true,
"is_deleted": false
},
"google_ads_login_customer_id": 123,
"google_business_location": {
"id": "<string>",
"title": "<string>",
"store_code": "<string>",
"maps_uri": "<string>",
"storefront_address": {
"region_code": "<string>",
"language_code": "<string>",
"postal_code": "<string>",
"administrative_area": "<string>",
"locality": "<string>",
"sublocality": "<string>",
"address_lines": [
"<string>"
]
}
},
"assistant": {
"id": "<string>",
"assistant_type": "onboarding",
"date_added": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z"
}
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
The Assistant types.
Available options:
onboarding, general, market_analysis, campaign_creation Response
Successful Response
extra_data
Extra data used to create the chat thread that is later passed to Assistant Functions (tool calls) · object | null
Schema for GoogleAdsCustomer model.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The schema for an assistant.
Show child attributes
Show child attributes