curl --request GET \
--url https://ds.cominty.com/chat \
--header 'x-cominty-token: <api-key>'import requests
url = "https://ds.cominty.com/chat"
headers = {"x-cominty-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-cominty-token': '<api-key>'}};
fetch('https://ds.cominty.com/chat', 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://ds.cominty.com/chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-cominty-token: <api-key>"
],
]);
$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://ds.cominty.com/chat"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-cominty-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://ds.cominty.com/chat")
.header("x-cominty-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ds.cominty.com/chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-cominty-token"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"live": true,
"starred": true,
"inception": "conversational"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}List threads
List threads for one end user. An API token requires user_id and lists that user’s API sessions. limit defaults to 50 and cannot exceed 100. page is zero-based. terms is a free-text search of at most 10 strings.
curl --request GET \
--url https://ds.cominty.com/chat \
--header 'x-cominty-token: <api-key>'import requests
url = "https://ds.cominty.com/chat"
headers = {"x-cominty-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-cominty-token': '<api-key>'}};
fetch('https://ds.cominty.com/chat', 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://ds.cominty.com/chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-cominty-token: <api-key>"
],
]);
$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://ds.cominty.com/chat"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-cominty-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://ds.cominty.com/chat")
.header("x-cominty-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ds.cominty.com/chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-cominty-token"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"live": true,
"starred": true,
"inception": "conversational"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
A Cominty Platform API secret. A key created now starts with sk-cmt-. Send it as is, or as Bearer sk-cmt-..., with at most one Bearer prefix. A key created before the prefix existed has no sk-cmt- and still works.
Query Parameters
End user whose threads to list. Required for an API token.
Product surface of the threads. An API token always lists api sessions, so you can omit this. api sessions are what an API token can list. portal is not used with an API token.
portal, api Page size. Defaults to 50. Maximum 100.
x <= 100Zero-based page index.
Free-text search terms. At most 10 strings.
10