import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/{conversation_id}/retry-turn/"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/{conversation_id}/retry-turn/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/{conversation_id}/retry-turn/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"turn_status": "idle",
"turn_error": "<string>",
"turn_events": [
{
"type_streaming": "<string>",
"payload": {}
}
],
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Retry a failed turn (async)
Answer again the user message the conversation’s last turn failed to answer
(its chat_history ends with a turn_error entry), and return 202 Accepted;
poll the poll endpoint as after send_message.
The turn_error entry is removed and the message is not sent again: the tool
calls the failed turn completed stay in the history, so they are not redone.
A conversation on the V1 assistant drops the failed turn and sends its message
again instead.
A turn fails, and is closed by a turn_error entry, when the model provider
stays unavailable after the automatic retries, or on an unexpected error.
The entry carries category (provider_unavailable, provider_declined or
unexpected), a user-facing content and an error_ref.
Access Control: as send_message.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/{conversation_id}/retry-turn/"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/{conversation_id}/retry-turn/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/{conversation_id}/retry-turn/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"turn_status": "idle",
"turn_error": "<string>",
"turn_events": [
{
"type_streaming": "<string>",
"payload": {}
}
],
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
Use Authorization: Bearer <token>. The token is either a user token / OAuth access
token, or a service-account API key (cfk_...). A key is valid on every endpoint and
acts as its service account, an organization member with per-store permissions.
Refused keys answer 403 with Invalid API key., API key revoked.,
API key expired. or API key disabled..
Headers
Email of the user to impersonate. Requires CAN_IMPERSONATE_OTHER_USERS permission.
If the target user is not found or does not have access to the project, the request
proceeds as the authenticated user. Contact Clarifeye to enable this permission.
Path Parameters
UUID of the project
UUID of the conversation
Response
Retry accepted and enqueued; poll for progress
In-flight turn state returned by the async send_message (202) and poll
endpoints for playground and Work-with-Clara conversations.
Lifecycle of the current chat turn
idle, running, failed User-facing reason when turn_status is failed (empty otherwise). Never
the raw exception: the error_ref in the streaming_error payload finds it.
Accumulated message-level events for the current turn. Each item mirrors
a former SSE frame: {type_streaming, payload} where type_streaming is
one of streaming_in_progress, streaming_error, streaming_completed, or
quick_replies_ready (Clara only). A streaming_error payload carries
category (provider_unavailable, provider_declined, unexpected),
error_ref and content; the turn is then closed in chat_history by a
turn_error entry, answerable with retry-turn.
Show child attributes
Show child attributes
Last activity timestamp; doubles as the turn staleness heartbeat