Skip to content

getAIConversation

GET
/api/v1/ai/conversations/{conversationId}
curl --request GET \
--url https://example.com/api/v1/ai/conversations/example
conversationId
required
string

OK

Media typeapplication/json
object
actions
required
Array<object>
object
arguments
required
created_at
required
string format: date-time
id
required
string
status
required
string
Allowed values: pending confirmed rejected auto_confirmed
tool
required
string
tool_call_id
required
string
key
additional properties
any
auto_accept
required

Mutating tool calls run without a confirm, unless the turn fetched a web page.

boolean
created_at
required
string format: date-time
draft_text
required
string
id
required
string
messages
required
Array<object>
object
content
required
Array<object>
object
input
is_error
boolean
label
string
stopped
boolean
text
string
tool_name
string
tool_use_id
string
type
required
string
key
additional properties
any
created_at
required
string format: date-time
id
required
string
role
required
string
Allowed values: user assistant tool
key
additional properties
any
title
required
string
turn_error
required
string
turn_status
required
string
Allowed values: idle running failed
turn_stop
required

Why the last turn ended: end_turn, pending_action, step_limit_reached, stopped or error. Empty while it runs.

string
key
additional properties
any
Example
{
"actions": [
{
"status": "pending"
}
],
"messages": [
{
"role": "user"
}
],
"turn_status": "idle"
}

Error

Media typeapplication/json
object
error
required
object
code
required
string
details
message
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"details": "example",
"message": "example"
}
}