/mistral-agents | Type: Application | PCID required: Yes
Tools
mistral_agents_api_v1_agents_create
Create a agent that can be used within a conversation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
completion_args | object | No | — | White-listed arguments from the completion API |
description | string | No | — | The description value |
guardrails | object[] | No | — | The guardrails value |
handoffs | string[] | No | — | The handoffs value |
instructions | string | No | — | Instruction prompt the model will follow during the conversation. |
metadata | object | No | — | Custom type for metadata with embedded validation. |
model | string | Yes | — | The model value |
name | string | Yes | — | The name value |
tools | any[] | No | — | List of tools which are available to the model during the conversation. |
version_message | string | No | — | Version Message |
mistral_agents_api_v1_agents_create_or_update_alias
Create or update an agent version alias. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | string | Yes | — | Agent Id |
alias | string | Yes | — | The alias value |
version | integer | Yes | — | The version value |
mistral_agents_api_v1_agents_delete
Delete an agent entity. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | string | Yes | — | Agent Id |
mistral_agents_api_v1_agents_delete_alias
Delete an agent version alias. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | string | Yes | — | Agent Id |
alias | string | Yes | — | The alias value |
mistral_agents_api_v1_agents_get
Retrieve an agent entity. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | string | Yes | — | Agent Id |
agent_version | object | No | — | Agent Version |
mistral_agents_api_v1_agents_get_version
Retrieve a specific version of an agent. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | string | Yes | — | Agent Id |
version | string | Yes | — | The version value |
mistral_agents_api_v1_agents_list
List agent entities. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number (0-indexed) |
page_size | integer | No | — | Number of agents per page |
deployment_chat | boolean | No | — | Deployment Chat |
sources | string[] | No | — | The sources value |
name | string | No | — | Filter by agent name |
search | string | No | — | Search agents by name or ID |
id | string | No | — | The id value |
metadata | string | No | — | The metadata value |
mistral_agents_api_v1_agents_list_version_aliases
List all aliases for an agent. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | string | Yes | — | Agent Id |
mistral_agents_api_v1_agents_list_versions
List all versions of an agent. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | string | Yes | — | Agent Id |
page | integer | No | — | Page number (0-indexed) |
page_size | integer | No | — | Number of versions per page |
mistral_agents_api_v1_agents_update
Update an agent entity. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | string | Yes | — | Agent Id |
completion_args | object | No | — | White-listed arguments from the completion API |
deployment_chat | boolean | No | — | Deployment Chat |
description | string | No | — | The description value |
guardrails | object[] | No | — | The guardrails value |
handoffs | string[] | No | — | The handoffs value |
instructions | string | No | — | Instruction prompt the model will follow during the conversation. |
metadata | object | No | — | Custom type for metadata with embedded validation. |
model | string | No | — | The model value |
name | string | No | — | The name value |
tools | any[] | No | — | List of tools which are available to the model during the conversation. |
version_message | string | No | — | Version Message |
mistral_agents_api_v1_agents_update_version
Update an agent version. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | string | Yes | — | Agent Id |
version | integer | Yes | — | The version value |
mistral_agents_api_v1_conversations_append
Append new entries to an existing conversation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversation_id | string | Yes | — | ID of the conversation to which we append entries. |
completion_args | object | No | — | White-listed arguments from the completion API |
handoff_execution | string | No | — | Handoff Execution |
inputs | object | No | — | The inputs value |
store | boolean | No | — | Whether to store the results into our servers or not. |
stream | boolean | No | — | The stream value |
tool_confirmations | object[] | No | — | Tool Confirmations |
mistral_agents_api_v1_conversations_delete
Delete a conversation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversation_id | string | Yes | — | ID of the conversation from which we are fetching metadata. |
mistral_agents_api_v1_conversations_get
Retrieve a conversation information. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversation_id | string | Yes | — | ID of the conversation from which we are fetching metadata. |
mistral_agents_api_v1_conversations_history
Retrieve all entries in a conversation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversation_id | string | Yes | — | ID of the conversation from which we are fetching entries. |
mistral_agents_api_v1_conversations_list
List all created conversations. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of results per page |
metadata | string | No | — | The metadata value |
mistral_agents_api_v1_conversations_messages
Retrieve all messages in a conversation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversation_id | string | Yes | — | ID of the conversation from which we are fetching messages. |
mistral_agents_api_v1_conversations_restart
Restart a conversation starting from a given entry. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversation_id | string | Yes | — | ID of the original conversation which is being restarted. |
agent_version | object | No | — | Specific version of the agent to use when restarting. If not provided, uses the current version. |
completion_args | object | No | — | White-listed arguments from the completion API |
from_entry_id | string | Yes | — | From Entry Id |
guardrails | object[] | No | — | The guardrails value |
handoff_execution | string | No | — | Handoff Execution |
inputs | object | No | — | The inputs value |
metadata | object | No | — | Custom metadata for the conversation. |
store | boolean | No | — | Whether to store the results into our servers or not. |
stream | boolean | No | — | The stream value |
mistral_agents_api_v1_conversations_start
Create a conversation and append entries to it. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_id | string | No | — | Agent Id |
agent_version | object | No | — | Agent Version |
completion_args | object | No | — | White-listed arguments from the completion API |
description | string | No | — | The description value |
guardrails | object[] | No | — | The guardrails value |
handoff_execution | string | No | — | Handoff Execution |
inputs | object | Yes | — | The inputs value |
instructions | string | No | — | The instructions value |
metadata | object | No | — | Custom type for metadata with embedded validation. |
model | string | No | — | The model value |
name | string | No | — | The name value |
store | boolean | No | — | The store value |
stream | boolean | No | — | The stream value |
tools | any[] | No | — | The tools value |

