Read a conversation
curl --request GET \
--url https://api.circuit.org/partner/conversations/{conversationId} \
--header 'Authorization: Bearer <token>' \
--header 'circuit-partner-version: <circuit-partner-version>'import requests
url = "https://api.circuit.org/partner/conversations/{conversationId}"
headers = {
"circuit-partner-version": "<circuit-partner-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'circuit-partner-version': '<circuit-partner-version>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.circuit.org/partner/conversations/{conversationId}', 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.circuit.org/partner/conversations/{conversationId}",
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>",
"circuit-partner-version: <circuit-partner-version>"
],
]);
$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.circuit.org/partner/conversations/{conversationId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("circuit-partner-version", "<circuit-partner-version>")
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.circuit.org/partner/conversations/{conversationId}")
.header("circuit-partner-version", "<circuit-partner-version>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.circuit.org/partner/conversations/{conversationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["circuit-partner-version"] = '<circuit-partner-version>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"turns": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "<string>",
"actions": [
{
"id": "<string>",
"title": "<string>",
"state": "<string>",
"decisions": [
"<string>"
],
"message": "<string>",
"agentId": "<string>"
}
],
"text": "<string>",
"message": "<string>"
}
],
"retryAfterMs": 1
}{
"error": "<string>"
}API Reference
Read a conversation
GET
/
partner
/
conversations
/
{conversationId}
Read a conversation
curl --request GET \
--url https://api.circuit.org/partner/conversations/{conversationId} \
--header 'Authorization: Bearer <token>' \
--header 'circuit-partner-version: <circuit-partner-version>'import requests
url = "https://api.circuit.org/partner/conversations/{conversationId}"
headers = {
"circuit-partner-version": "<circuit-partner-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'circuit-partner-version': '<circuit-partner-version>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.circuit.org/partner/conversations/{conversationId}', 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.circuit.org/partner/conversations/{conversationId}",
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>",
"circuit-partner-version: <circuit-partner-version>"
],
]);
$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.circuit.org/partner/conversations/{conversationId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("circuit-partner-version", "<circuit-partner-version>")
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.circuit.org/partner/conversations/{conversationId}")
.header("circuit-partner-version", "<circuit-partner-version>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.circuit.org/partner/conversations/{conversationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["circuit-partner-version"] = '<circuit-partner-version>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"turns": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "<string>",
"actions": [
{
"id": "<string>",
"title": "<string>",
"state": "<string>",
"decisions": [
"<string>"
],
"message": "<string>",
"agentId": "<string>"
}
],
"text": "<string>",
"message": "<string>"
}
],
"retryAfterMs": 1
}{
"error": "<string>"
}Authorizations
The permit the user approved for your app.
Headers
Allowed value:
"0.1"