curl --request POST \
--url https://api.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/', 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.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-API-Key: <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.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_message_sequence": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Stop an AI Assistant chat turn
Ask the turn whose user message sits at sequence (the streaming route’s turn frame names it) to stop at its next check. The turn stops before its model call, or within a second while the model writes, and lands as a result whose reply carries failed and reads Stopped by you; the workspace’s allowance is not charged for it. Idempotent, and harmless once the turn has landed: a Stop nobody is listening for expires on its own.
curl --request POST \
--url https://api.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/', 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.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-API-Key: <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.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/assistant/chat/conversations/{conversation_id}/messages/{sequence}/stop/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_message_sequence": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Response
Successful Response
A Stop was asked for. Whether it lands is the stream's to say.
The flag is cooperative and best effort: the turn reads it before its
model call and while the model writes, and a turn that has already landed
is not affected. The stream reports the outcome as a result whose reply
carries failed and reads Stopped by you. Echoes the turn the Stop was
addressed to, as the turn frame named it.
Was this page helpful?