Skip to main content
POST
Create a conversation turn in a thread

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

query
string | null
force_tool
string
suggested_query_id
integer
force_mcp_server
string
immediate_final_answer
boolean
default:false
stream
boolean
default:false
background
boolean
default:false
system_prompt_suffix
string
Maximum string length: 5000
max_steps
integer
default:8
Required range: 1 <= x <= 20
response_format
any
tool_parameters
any
workspace_ids
integer[]
file_ids
integer[]
tag_ids
integer[]
private_scope
boolean
company_scope
boolean

Response

Final answer returned synchronously.

id
string
required
thread
string
required
status
enum<string>
required
  • running - running
  • completed - completed
  • failed - failed
  • cancelled - cancelled
  • cancelling - cancelling
Available options:
running,
completed,
failed,
cancelled,
cancelling
messages
object[]
required
created_at
string<date-time>
required
object
string
default:turn
error
object | null
liked
boolean | null