Skip to main content
Server path: /mistral-agents | Type: Application | PCID required: Yes

Tools

ToolDescription
mistral_agents_api_v1_agents_createCreate a agent that can be used within a conversation.
mistral_agents_api_v1_agents_create_or_update_aliasCreate or update an agent version alias.
mistral_agents_api_v1_agents_deleteDelete an agent entity.
mistral_agents_api_v1_agents_delete_aliasDelete an agent version alias.
mistral_agents_api_v1_agents_getRetrieve an agent entity.
mistral_agents_api_v1_agents_get_versionRetrieve a specific version of an agent.
mistral_agents_api_v1_agents_listList agent entities.
mistral_agents_api_v1_agents_list_version_aliasesList all aliases for an agent.
mistral_agents_api_v1_agents_list_versionsList all versions of an agent.
mistral_agents_api_v1_agents_updateUpdate an agent entity.
mistral_agents_api_v1_agents_update_versionUpdate an agent version.
mistral_agents_api_v1_conversations_appendAppend new entries to an existing conversation.
mistral_agents_api_v1_conversations_deleteDelete a conversation.
mistral_agents_api_v1_conversations_getRetrieve a conversation information.
mistral_agents_api_v1_conversations_historyRetrieve all entries in a conversation.
mistral_agents_api_v1_conversations_listList all created conversations.
mistral_agents_api_v1_conversations_messagesRetrieve all messages in a conversation.
mistral_agents_api_v1_conversations_restartRestart a conversation starting from a given entry.
mistral_agents_api_v1_conversations_startCreate a conversation and append entries to it.

mistral_agents_api_v1_agents_create

Create a agent that can be used within a conversation. Parameters:
ParameterTypeRequiredDefaultDescription
completion_argsobjectNoWhite-listed arguments from the completion API
descriptionstringNoThe description value
guardrailsobject[]NoThe guardrails value
handoffsstring[]NoThe handoffs value
instructionsstringNoInstruction prompt the model will follow during the conversation.
metadataobjectNoCustom type for metadata with embedded validation.
modelstringYesThe model value
namestringYesThe name value
toolsany[]NoList of tools which are available to the model during the conversation.
version_messagestringNoVersion Message

mistral_agents_api_v1_agents_create_or_update_alias

Create or update an agent version alias. Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesAgent Id
aliasstringYesThe alias value
versionintegerYesThe version value

mistral_agents_api_v1_agents_delete

Delete an agent entity. Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesAgent Id

mistral_agents_api_v1_agents_delete_alias

Delete an agent version alias. Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesAgent Id
aliasstringYesThe alias value

mistral_agents_api_v1_agents_get

Retrieve an agent entity. Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesAgent Id
agent_versionobjectNoAgent Version

mistral_agents_api_v1_agents_get_version

Retrieve a specific version of an agent. Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesAgent Id
versionstringYesThe version value

mistral_agents_api_v1_agents_list

List agent entities. Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number (0-indexed)
page_sizeintegerNoNumber of agents per page
deployment_chatbooleanNoDeployment Chat
sourcesstring[]NoThe sources value
namestringNoFilter by agent name
searchstringNoSearch agents by name or ID
idstringNoThe id value
metadatastringNoThe metadata value

mistral_agents_api_v1_agents_list_version_aliases

List all aliases for an agent. Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesAgent Id

mistral_agents_api_v1_agents_list_versions

List all versions of an agent. Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesAgent Id
pageintegerNoPage number (0-indexed)
page_sizeintegerNoNumber of versions per page

mistral_agents_api_v1_agents_update

Update an agent entity. Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesAgent Id
completion_argsobjectNoWhite-listed arguments from the completion API
deployment_chatbooleanNoDeployment Chat
descriptionstringNoThe description value
guardrailsobject[]NoThe guardrails value
handoffsstring[]NoThe handoffs value
instructionsstringNoInstruction prompt the model will follow during the conversation.
metadataobjectNoCustom type for metadata with embedded validation.
modelstringNoThe model value
namestringNoThe name value
toolsany[]NoList of tools which are available to the model during the conversation.
version_messagestringNoVersion Message

mistral_agents_api_v1_agents_update_version

Update an agent version. Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesAgent Id
versionintegerYesThe version value

mistral_agents_api_v1_conversations_append

Append new entries to an existing conversation. Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesID of the conversation to which we append entries.
completion_argsobjectNoWhite-listed arguments from the completion API
handoff_executionstringNoHandoff Execution
inputsobjectNoThe inputs value
storebooleanNoWhether to store the results into our servers or not.
streambooleanNoThe stream value
tool_confirmationsobject[]NoTool Confirmations

mistral_agents_api_v1_conversations_delete

Delete a conversation. Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesID of the conversation from which we are fetching metadata.

mistral_agents_api_v1_conversations_get

Retrieve a conversation information. Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesID of the conversation from which we are fetching metadata.

mistral_agents_api_v1_conversations_history

Retrieve all entries in a conversation. Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesID of the conversation from which we are fetching entries.

mistral_agents_api_v1_conversations_list

List all created conversations. Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of results per page
metadatastringNoThe metadata value

mistral_agents_api_v1_conversations_messages

Retrieve all messages in a conversation. Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesID of the conversation from which we are fetching messages.

mistral_agents_api_v1_conversations_restart

Restart a conversation starting from a given entry. Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesID of the original conversation which is being restarted.
agent_versionobjectNoSpecific version of the agent to use when restarting. If not provided, uses the current version.
completion_argsobjectNoWhite-listed arguments from the completion API
from_entry_idstringYesFrom Entry Id
guardrailsobject[]NoThe guardrails value
handoff_executionstringNoHandoff Execution
inputsobjectNoThe inputs value
metadataobjectNoCustom metadata for the conversation.
storebooleanNoWhether to store the results into our servers or not.
streambooleanNoThe stream value

mistral_agents_api_v1_conversations_start

Create a conversation and append entries to it. Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringNoAgent Id
agent_versionobjectNoAgent Version
completion_argsobjectNoWhite-listed arguments from the completion API
descriptionstringNoThe description value
guardrailsobject[]NoThe guardrails value
handoff_executionstringNoHandoff Execution
inputsobjectYesThe inputs value
instructionsstringNoThe instructions value
metadataobjectNoCustom type for metadata with embedded validation.
modelstringNoThe model value
namestringNoThe name value
storebooleanNoThe store value
streambooleanNoThe stream value
toolsany[]NoThe tools value