Skip to content

createAIConversation

POST
/api/v1/ai/conversations
curl --request POST \
--url https://example.com/api/v1/ai/conversations \
--header 'Content-Type: application/json' \
--data '{ "title": "example" }'
Media typeapplication/json
object
title
string
<= 200 characters
key
additional properties
any
Examplegenerated
{
"title": "example"
}

Created

Media typeapplication/json
object
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
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
{
"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"
}
}