MistralClient.API.Beta (mistralex_ai v0.1.0)

View Source

Beta API endpoints for experimental Mistral AI features.

This module provides access to experimental features that are in beta testing. These APIs may change without notice and should be used with caution in production.

Available Beta APIs

  • Agents API: Create and manage AI agents with specific instructions and tools
  • Conversations API: Manage persistent conversations with agents

Usage

# Create an agent
{:ok, agent} = MistralClient.API.Beta.create_agent(%{
  name: "Customer Support Agent",
  model: "mistral-large-latest",
  instructions: "You are a helpful customer support agent."
})

# Start a conversation
{:ok, conversation} = MistralClient.API.Beta.start_conversation(%{
  agent_id: agent.id,
  inputs: "Hello, I need help with my order."
})

Summary

Functions

Check if Beta APIs are available.

Get beta API status and available features.

Functions

append_to_conversation(config, conversation_id, request)

See MistralClient.API.Beta.Conversations.append/3.

append_to_conversation_stream(config, conversation_id, request, callback)

See MistralClient.API.Beta.Conversations.append_stream/4.

beta_available?(config)

@spec beta_available?(MistralClient.Config.t()) :: boolean()

Check if Beta APIs are available.

Returns true if the current API key has access to beta features.

beta_status(config)

@spec beta_status(MistralClient.Config.t()) :: {:ok, map()} | {:error, term()}

Get beta API status and available features.

create_agent(config, request)

See MistralClient.API.Beta.Agents.create/2.

get_agent(config, agent_id)

See MistralClient.API.Beta.Agents.get/2.

get_conversation(config, conversation_id)

See MistralClient.API.Beta.Conversations.get/2.

get_conversation_history(config, conversation_id)

See MistralClient.API.Beta.Conversations.history/2.

get_conversation_messages(config, conversation_id)

See MistralClient.API.Beta.Conversations.messages/2.

list_agents(config, options \\ %{})

See MistralClient.API.Beta.Agents.list/2.

list_conversations(config, options \\ %{})

See MistralClient.API.Beta.Conversations.list/2.

restart_conversation(config, conversation_id, request)

See MistralClient.API.Beta.Conversations.restart/3.

restart_conversation_stream(config, conversation_id, request, callback)

See MistralClient.API.Beta.Conversations.restart_stream/4.

start_conversation(config, request)

See MistralClient.API.Beta.Conversations.start/2.

start_conversation_stream(config, request, callback)

See MistralClient.API.Beta.Conversations.start_stream/3.

update_agent(config, agent_id, updates)

See MistralClient.API.Beta.Agents.update/3.

update_agent_version(config, agent_id, version)

See MistralClient.API.Beta.Agents.update_version/3.