Get conversation configurations
curl --request GET \
--url https://api.siro.ai/v1/core/conversation-configurations \
--header 'x-siro-auth-token: <api-key>'import requests
url = "https://api.siro.ai/v1/core/conversation-configurations"
headers = {"x-siro-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-siro-auth-token': '<api-key>'}};
fetch('https://api.siro.ai/v1/core/conversation-configurations', 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.siro.ai/v1/core/conversation-configurations",
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-siro-auth-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://api.siro.ai/v1/core/conversation-configurations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-siro-auth-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://api.siro.ai/v1/core/conversation-configurations")
.header("x-siro-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siro.ai/v1/core/conversation-configurations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-siro-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"expressions": [
{
"title": "<string>",
"identifiers": [
null
],
"overrideParent": true,
"advancedBookmarkModelId": "<string>",
"bookmarkConfigId": "<string>"
}
],
"debriefQuestions": [
{
"id": "<string>",
"prompt": "<string>",
"responseConfig": {
"includeTime": true,
"required": true,
"latestAllowableDate": "<string>",
"earliestAllowableDate": "<string>"
},
"sortValue": 123,
"promptDetails": "<string>",
"includeIf": [
{
"questionId": "<string>",
"value": "<string>"
}
],
"onlyIncludeIfFlagged": true,
"setResponseToField": "<string>",
"hideFromResults": true
}
],
"belongsToConfigGroups": [
"<string>"
],
"id": "<string>",
"conversationType": "<string>",
"displayName": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"userId": "<string>",
"displayBookmarksInDebrief": true,
"overrideAllParentExpressions": true,
"titleQuestionId": "<string>",
"resultQuestionId": "<string>",
"tagConfigurations": [
{
"displayName": "<string>",
"applyIf": {
"tagExpressionType": "BOOKMARK_TAG_EXPRESSION",
"bookmarkTitle": "<string>"
}
}
],
"inheritedBookmarkConfigIds": [
"<string>"
],
"inheritedBookmarkConfigs_denormalized": {},
"checklistId": "<string>",
"chatBotKnowledgeBaseIds": [
"<string>"
],
"bookmarkGroupIds": [
"<string>"
],
"halftimeModeEnabled": true,
"summaryPrompts": [
{
"id": "<string>",
"prompt": "<string>",
"promptIndex": 123,
"promptHeader": "<string>"
}
]
}
],
"cursor": "<string>",
"pageSize": 123,
"limit": 123,
"total": 123,
"hasNextPage": true
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"issues": [
{
"code": "<string>",
"path": [
"<string>"
],
"message": "<string>",
"expected": "<string>",
"received": "<string>"
}
],
"name": "ZodError"
}{
"error": "<string>"
}Conversation Configurations
Get conversation configurations
Retrieves conversation configurations for an organization. Users can only access configurations for their own organization unless they are organization admins.
GET
/
v1
/
core
/
conversation-configurations
Get conversation configurations
curl --request GET \
--url https://api.siro.ai/v1/core/conversation-configurations \
--header 'x-siro-auth-token: <api-key>'import requests
url = "https://api.siro.ai/v1/core/conversation-configurations"
headers = {"x-siro-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-siro-auth-token': '<api-key>'}};
fetch('https://api.siro.ai/v1/core/conversation-configurations', 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.siro.ai/v1/core/conversation-configurations",
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-siro-auth-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://api.siro.ai/v1/core/conversation-configurations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-siro-auth-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://api.siro.ai/v1/core/conversation-configurations")
.header("x-siro-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.siro.ai/v1/core/conversation-configurations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-siro-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"expressions": [
{
"title": "<string>",
"identifiers": [
null
],
"overrideParent": true,
"advancedBookmarkModelId": "<string>",
"bookmarkConfigId": "<string>"
}
],
"debriefQuestions": [
{
"id": "<string>",
"prompt": "<string>",
"responseConfig": {
"includeTime": true,
"required": true,
"latestAllowableDate": "<string>",
"earliestAllowableDate": "<string>"
},
"sortValue": 123,
"promptDetails": "<string>",
"includeIf": [
{
"questionId": "<string>",
"value": "<string>"
}
],
"onlyIncludeIfFlagged": true,
"setResponseToField": "<string>",
"hideFromResults": true
}
],
"belongsToConfigGroups": [
"<string>"
],
"id": "<string>",
"conversationType": "<string>",
"displayName": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"userId": "<string>",
"displayBookmarksInDebrief": true,
"overrideAllParentExpressions": true,
"titleQuestionId": "<string>",
"resultQuestionId": "<string>",
"tagConfigurations": [
{
"displayName": "<string>",
"applyIf": {
"tagExpressionType": "BOOKMARK_TAG_EXPRESSION",
"bookmarkTitle": "<string>"
}
}
],
"inheritedBookmarkConfigIds": [
"<string>"
],
"inheritedBookmarkConfigs_denormalized": {},
"checklistId": "<string>",
"chatBotKnowledgeBaseIds": [
"<string>"
],
"bookmarkGroupIds": [
"<string>"
],
"halftimeModeEnabled": true,
"summaryPrompts": [
{
"id": "<string>",
"prompt": "<string>",
"promptIndex": 123,
"promptHeader": "<string>"
}
]
}
],
"cursor": "<string>",
"pageSize": 123,
"limit": 123,
"total": 123,
"hasNextPage": true
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"issues": [
{
"code": "<string>",
"path": [
"<string>"
],
"message": "<string>",
"expected": "<string>",
"received": "<string>"
}
],
"name": "ZodError"
}{
"error": "<string>"
}Authorizations
OAuth access token for user-scoped requests (Authorization Code or machine-to-machine). Send header x-siro-auth-token: <oauth-access-token>. Not an organization API key.
Query Parameters
The organization ID to get conversation configurations for
⌘I