v2

latestOpenAPI 3.1.02026-07-262937191.0 MB

beta.conversations

Create a conversation and append entries to it.

Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation.

post/v1/conversations

Request body

streamfalse

storeboolean nullable

handoff_execution'client' | 'server' nullable

instructionsstring nullable

namestring nullable

descriptionstring nullable

metadataMetadataDict

Custom type for metadata with embedded validation.

agent_idstring nullable

modelstring nullable

Response

Successful Response

object'conversation.response'

conversation_idstring required

guardrailsobject[] nullable