beta.conversations

Create a conversation and append entries to it.

Changed on

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

Request body

streamfalse nullable
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

Changes

    • warning

      added the new mistral_mcp enum value to the //////// response property for the response status

    • warning

      added the new mistral_mcp enum value to the /////////// response property for the response status

    • warning

      added the new mistral_mcp enum value to the //////// response property for the response status

    • warning

      added the new mistral_mcp enum value to the //// response property for the response status

    • info

      added the new mistral_mcp enum value to the request property //////////

    • info

      added the new mistral_mcp enum value to the request property /////////////

    • info

      added the new mistral_mcp enum value to the request property //////////

    • info

      added the new mistral_mcp enum value to the request property /////////////

    • info

      added the new mistral_mcp enum value to the request property //////////

    • info

      added the new mistral_mcp enum value to the request property //////

    • breaking

      removed subschema #1 from the /// request property anyOf list

    • breaking

      response property outputs/items/anyOf[subschema #1: MessageOutputEntry]/content/anyOf[subschema #2: MessageOutputContentChunks]/items/anyOf[subschema #5: ThinkChunk]/thinking/items/anyOf[subschema #3: ReferenceChunk]/reference_ids/items/ list-of-types was widened by adding types string to media type application/json of response 200

    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////////

    • info

      added to the /// request property anyOf list

    • info

      request property ///////////// list-of-types was widened by adding types string to media type application/json

    • info

      request property ///////////// list-of-types was widened by adding types string to media type application/json

    • info

      added the optional property /////// to the response with the status