Send a turn and wait for the full response
curl --request POST \
--url https://api.semicola.com/api/v2/assistant/chat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompt": "<string>",
"scopeId": "<string>",
"attachments": [
{
"attachmentId": "<string>",
"filename": "<string>",
"mimeType": "<string>",
"bytes": 4503599627370495
}
],
"pageContext": {
"route": "<string>",
"title": "<string>",
"extra": {
"workspace": "<string>",
"scopeName": "<string>",
"intent": "<string>",
"entity": "<string>",
"feature": "<string>",
"learningMode": "<string>",
"diagnosticsSourceId": "<string>",
"diagnosticsSourceName": "<string>"
}
},
"conversationUid": "<string>",
"modelContext": [
{
"text": "<string>",
"resourceUri": "<string>",
"data": "<unknown>"
}
]
}
'import requests
url = "https://api.semicola.com/api/v2/assistant/chat"
payload = {
"prompt": "<string>",
"scopeId": "<string>",
"attachments": [
{
"attachmentId": "<string>",
"filename": "<string>",
"mimeType": "<string>",
"bytes": 4503599627370495
}
],
"pageContext": {
"route": "<string>",
"title": "<string>",
"extra": {
"workspace": "<string>",
"scopeName": "<string>",
"intent": "<string>",
"entity": "<string>",
"feature": "<string>",
"learningMode": "<string>",
"diagnosticsSourceId": "<string>",
"diagnosticsSourceName": "<string>"
}
},
"conversationUid": "<string>",
"modelContext": [
{
"text": "<string>",
"resourceUri": "<string>",
"data": "<unknown>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
prompt: '<string>',
scopeId: '<string>',
attachments: [
{
attachmentId: '<string>',
filename: '<string>',
mimeType: '<string>',
bytes: 4503599627370495
}
],
pageContext: {
route: '<string>',
title: '<string>',
extra: {
workspace: '<string>',
scopeName: '<string>',
intent: '<string>',
entity: '<string>',
feature: '<string>',
learningMode: '<string>',
diagnosticsSourceId: '<string>',
diagnosticsSourceName: '<string>'
}
},
conversationUid: '<string>',
modelContext: [{text: '<string>', resourceUri: '<string>', data: '<unknown>'}]
})
};
fetch('https://api.semicola.com/api/v2/assistant/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://api.semicola.com/api/v2/assistant/chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'prompt' => '<string>',
'scopeId' => '<string>',
'attachments' => [
[
'attachmentId' => '<string>',
'filename' => '<string>',
'mimeType' => '<string>',
'bytes' => 4503599627370495
]
],
'pageContext' => [
'route' => '<string>',
'title' => '<string>',
'extra' => [
'workspace' => '<string>',
'scopeName' => '<string>',
'intent' => '<string>',
'entity' => '<string>',
'feature' => '<string>',
'learningMode' => '<string>',
'diagnosticsSourceId' => '<string>',
'diagnosticsSourceName' => '<string>'
]
],
'conversationUid' => '<string>',
'modelContext' => [
[
'text' => '<string>',
'resourceUri' => '<string>',
'data' => '<unknown>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.semicola.com/api/v2/assistant/chat"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"scopeId\": \"<string>\",\n \"attachments\": [\n {\n \"attachmentId\": \"<string>\",\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"bytes\": 4503599627370495\n }\n ],\n \"pageContext\": {\n \"route\": \"<string>\",\n \"title\": \"<string>\",\n \"extra\": {\n \"workspace\": \"<string>\",\n \"scopeName\": \"<string>\",\n \"intent\": \"<string>\",\n \"entity\": \"<string>\",\n \"feature\": \"<string>\",\n \"learningMode\": \"<string>\",\n \"diagnosticsSourceId\": \"<string>\",\n \"diagnosticsSourceName\": \"<string>\"\n }\n },\n \"conversationUid\": \"<string>\",\n \"modelContext\": [\n {\n \"text\": \"<string>\",\n \"resourceUri\": \"<string>\",\n \"data\": \"<unknown>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.semicola.com/api/v2/assistant/chat")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"scopeId\": \"<string>\",\n \"attachments\": [\n {\n \"attachmentId\": \"<string>\",\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"bytes\": 4503599627370495\n }\n ],\n \"pageContext\": {\n \"route\": \"<string>\",\n \"title\": \"<string>\",\n \"extra\": {\n \"workspace\": \"<string>\",\n \"scopeName\": \"<string>\",\n \"intent\": \"<string>\",\n \"entity\": \"<string>\",\n \"feature\": \"<string>\",\n \"learningMode\": \"<string>\",\n \"diagnosticsSourceId\": \"<string>\",\n \"diagnosticsSourceName\": \"<string>\"\n }\n },\n \"conversationUid\": \"<string>\",\n \"modelContext\": [\n {\n \"text\": \"<string>\",\n \"resourceUri\": \"<string>\",\n \"data\": \"<unknown>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.semicola.com/api/v2/assistant/chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompt\": \"<string>\",\n \"scopeId\": \"<string>\",\n \"attachments\": [\n {\n \"attachmentId\": \"<string>\",\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"bytes\": 4503599627370495\n }\n ],\n \"pageContext\": {\n \"route\": \"<string>\",\n \"title\": \"<string>\",\n \"extra\": {\n \"workspace\": \"<string>\",\n \"scopeName\": \"<string>\",\n \"intent\": \"<string>\",\n \"entity\": \"<string>\",\n \"feature\": \"<string>\",\n \"learningMode\": \"<string>\",\n \"diagnosticsSourceId\": \"<string>\",\n \"diagnosticsSourceName\": \"<string>\"\n }\n },\n \"conversationUid\": \"<string>\",\n \"modelContext\": [\n {\n \"text\": \"<string>\",\n \"resourceUri\": \"<string>\",\n \"data\": \"<unknown>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"conversationUid": "<string>",
"answer": "<string>",
"toolsUsed": [
{
"name": "<string>",
"input": "<unknown>",
"output": "<unknown>",
"isError": true
}
],
"pendingConfirmations": [
{
"status": "pending_confirmation",
"confirmationUid": "<string>",
"toolName": "<string>",
"toolKey": "<string>",
"summary": "<string>",
"policy": "always",
"resolvedParams": {},
"writeExecuted": false,
"plainAffirmativeAccepted": true,
"expiresAt": "2023-11-07T05:31:56Z",
"risk": "none"
}
],
"mcpAppWidget": {
"kind": "page",
"resourceUri": "<string>",
"title": "<string>",
"description": "<string>",
"data": "<unknown>",
"suppressUserMessage": true
},
"customerSwitch": {
"customerId": 123,
"customerName": "<string>",
"accountType": "BUYER"
}
},
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": "<unknown>"
}
}Assistant
Send a turn and wait for the full response
POST
/
api
/
v2
/
assistant
/
chat
Send a turn and wait for the full response
curl --request POST \
--url https://api.semicola.com/api/v2/assistant/chat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompt": "<string>",
"scopeId": "<string>",
"attachments": [
{
"attachmentId": "<string>",
"filename": "<string>",
"mimeType": "<string>",
"bytes": 4503599627370495
}
],
"pageContext": {
"route": "<string>",
"title": "<string>",
"extra": {
"workspace": "<string>",
"scopeName": "<string>",
"intent": "<string>",
"entity": "<string>",
"feature": "<string>",
"learningMode": "<string>",
"diagnosticsSourceId": "<string>",
"diagnosticsSourceName": "<string>"
}
},
"conversationUid": "<string>",
"modelContext": [
{
"text": "<string>",
"resourceUri": "<string>",
"data": "<unknown>"
}
]
}
'import requests
url = "https://api.semicola.com/api/v2/assistant/chat"
payload = {
"prompt": "<string>",
"scopeId": "<string>",
"attachments": [
{
"attachmentId": "<string>",
"filename": "<string>",
"mimeType": "<string>",
"bytes": 4503599627370495
}
],
"pageContext": {
"route": "<string>",
"title": "<string>",
"extra": {
"workspace": "<string>",
"scopeName": "<string>",
"intent": "<string>",
"entity": "<string>",
"feature": "<string>",
"learningMode": "<string>",
"diagnosticsSourceId": "<string>",
"diagnosticsSourceName": "<string>"
}
},
"conversationUid": "<string>",
"modelContext": [
{
"text": "<string>",
"resourceUri": "<string>",
"data": "<unknown>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
prompt: '<string>',
scopeId: '<string>',
attachments: [
{
attachmentId: '<string>',
filename: '<string>',
mimeType: '<string>',
bytes: 4503599627370495
}
],
pageContext: {
route: '<string>',
title: '<string>',
extra: {
workspace: '<string>',
scopeName: '<string>',
intent: '<string>',
entity: '<string>',
feature: '<string>',
learningMode: '<string>',
diagnosticsSourceId: '<string>',
diagnosticsSourceName: '<string>'
}
},
conversationUid: '<string>',
modelContext: [{text: '<string>', resourceUri: '<string>', data: '<unknown>'}]
})
};
fetch('https://api.semicola.com/api/v2/assistant/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://api.semicola.com/api/v2/assistant/chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'prompt' => '<string>',
'scopeId' => '<string>',
'attachments' => [
[
'attachmentId' => '<string>',
'filename' => '<string>',
'mimeType' => '<string>',
'bytes' => 4503599627370495
]
],
'pageContext' => [
'route' => '<string>',
'title' => '<string>',
'extra' => [
'workspace' => '<string>',
'scopeName' => '<string>',
'intent' => '<string>',
'entity' => '<string>',
'feature' => '<string>',
'learningMode' => '<string>',
'diagnosticsSourceId' => '<string>',
'diagnosticsSourceName' => '<string>'
]
],
'conversationUid' => '<string>',
'modelContext' => [
[
'text' => '<string>',
'resourceUri' => '<string>',
'data' => '<unknown>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.semicola.com/api/v2/assistant/chat"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"scopeId\": \"<string>\",\n \"attachments\": [\n {\n \"attachmentId\": \"<string>\",\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"bytes\": 4503599627370495\n }\n ],\n \"pageContext\": {\n \"route\": \"<string>\",\n \"title\": \"<string>\",\n \"extra\": {\n \"workspace\": \"<string>\",\n \"scopeName\": \"<string>\",\n \"intent\": \"<string>\",\n \"entity\": \"<string>\",\n \"feature\": \"<string>\",\n \"learningMode\": \"<string>\",\n \"diagnosticsSourceId\": \"<string>\",\n \"diagnosticsSourceName\": \"<string>\"\n }\n },\n \"conversationUid\": \"<string>\",\n \"modelContext\": [\n {\n \"text\": \"<string>\",\n \"resourceUri\": \"<string>\",\n \"data\": \"<unknown>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.semicola.com/api/v2/assistant/chat")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"scopeId\": \"<string>\",\n \"attachments\": [\n {\n \"attachmentId\": \"<string>\",\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"bytes\": 4503599627370495\n }\n ],\n \"pageContext\": {\n \"route\": \"<string>\",\n \"title\": \"<string>\",\n \"extra\": {\n \"workspace\": \"<string>\",\n \"scopeName\": \"<string>\",\n \"intent\": \"<string>\",\n \"entity\": \"<string>\",\n \"feature\": \"<string>\",\n \"learningMode\": \"<string>\",\n \"diagnosticsSourceId\": \"<string>\",\n \"diagnosticsSourceName\": \"<string>\"\n }\n },\n \"conversationUid\": \"<string>\",\n \"modelContext\": [\n {\n \"text\": \"<string>\",\n \"resourceUri\": \"<string>\",\n \"data\": \"<unknown>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.semicola.com/api/v2/assistant/chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompt\": \"<string>\",\n \"scopeId\": \"<string>\",\n \"attachments\": [\n {\n \"attachmentId\": \"<string>\",\n \"filename\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"bytes\": 4503599627370495\n }\n ],\n \"pageContext\": {\n \"route\": \"<string>\",\n \"title\": \"<string>\",\n \"extra\": {\n \"workspace\": \"<string>\",\n \"scopeName\": \"<string>\",\n \"intent\": \"<string>\",\n \"entity\": \"<string>\",\n \"feature\": \"<string>\",\n \"learningMode\": \"<string>\",\n \"diagnosticsSourceId\": \"<string>\",\n \"diagnosticsSourceName\": \"<string>\"\n }\n },\n \"conversationUid\": \"<string>\",\n \"modelContext\": [\n {\n \"text\": \"<string>\",\n \"resourceUri\": \"<string>\",\n \"data\": \"<unknown>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"conversationUid": "<string>",
"answer": "<string>",
"toolsUsed": [
{
"name": "<string>",
"input": "<unknown>",
"output": "<unknown>",
"isError": true
}
],
"pendingConfirmations": [
{
"status": "pending_confirmation",
"confirmationUid": "<string>",
"toolName": "<string>",
"toolKey": "<string>",
"summary": "<string>",
"policy": "always",
"resolvedParams": {},
"writeExecuted": false,
"plainAffirmativeAccepted": true,
"expiresAt": "2023-11-07T05:31:56Z",
"risk": "none"
}
],
"mcpAppWidget": {
"kind": "page",
"resourceUri": "<string>",
"title": "<string>",
"description": "<string>",
"data": "<unknown>",
"suppressUserMessage": true
},
"customerSwitch": {
"customerId": 123,
"customerName": "<string>",
"accountType": "BUYER"
}
},
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": "<unknown>"
}
}Authorizations
bearerAuthsessionCookie
API key or OAuth access token.
Body
application/json
Maximum string length:
32000Available options:
customer, advertiser Minimum string length:
1Maximum array length:
5Show child attributes
Show child attributes
Show child attributes
Show child attributes
Minimum string length:
6Available options:
ar, de, en, es, fr, hi, it, ko, nl, pl, pt, sv, tr, ja, zh Show child attributes
Show child attributes