mistral-openapi-client 0.1.0

Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355

# \BetaConversationsApi

All URIs are relative to *https://api.mistral.ai*

Method | HTTP request | Description
------------- | ------------- | -------------
[**agents_api_v1_conversations_append**](BetaConversationsApi.md#agents_api_v1_conversations_append) | **POST** /v1/conversations/{conversation_id} | Append new entries to an existing conversation.
[**agents_api_v1_conversations_append_stream**](BetaConversationsApi.md#agents_api_v1_conversations_append_stream) | **POST** /v1/conversations/{conversation_id}#stream | Append new entries to an existing conversation.
[**agents_api_v1_conversations_delete**](BetaConversationsApi.md#agents_api_v1_conversations_delete) | **DELETE** /v1/conversations/{conversation_id} | Delete a conversation.
[**agents_api_v1_conversations_get**](BetaConversationsApi.md#agents_api_v1_conversations_get) | **GET** /v1/conversations/{conversation_id} | Retrieve a conversation information.
[**agents_api_v1_conversations_history**](BetaConversationsApi.md#agents_api_v1_conversations_history) | **GET** /v1/conversations/{conversation_id}/history | Retrieve all entries in a conversation.
[**agents_api_v1_conversations_list**](BetaConversationsApi.md#agents_api_v1_conversations_list) | **GET** /v1/conversations | List all created conversations.
[**agents_api_v1_conversations_messages**](BetaConversationsApi.md#agents_api_v1_conversations_messages) | **GET** /v1/conversations/{conversation_id}/messages | Retrieve all messages in a conversation.
[**agents_api_v1_conversations_restart**](BetaConversationsApi.md#agents_api_v1_conversations_restart) | **POST** /v1/conversations/{conversation_id}/restart | Restart a conversation starting from a given entry.
[**agents_api_v1_conversations_restart_stream**](BetaConversationsApi.md#agents_api_v1_conversations_restart_stream) | **POST** /v1/conversations/{conversation_id}/restart#stream | Restart a conversation starting from a given entry.
[**agents_api_v1_conversations_start**](BetaConversationsApi.md#agents_api_v1_conversations_start) | **POST** /v1/conversations | Create a conversation and append entries to it.
[**agents_api_v1_conversations_start_stream**](BetaConversationsApi.md#agents_api_v1_conversations_start_stream) | **POST** /v1/conversations#stream | Create a conversation and append entries to it.



## agents_api_v1_conversations_append

> models::ConversationResponse agents_api_v1_conversations_append(conversation_id, conversation_append_request)
Append new entries to an existing conversation.

Run completion on the history of the conversation and the user entries. Return the new created entries.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**conversation_id** | **String** | ID of the conversation to which we append entries. | [required] |
**conversation_append_request** | [**ConversationAppendRequest**](ConversationAppendRequest.md) |  | [required] |

### Return type

[**models::ConversationResponse**](ConversationResponse.md)

### Authorization

[ApiKey](../README.md#ApiKey)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## agents_api_v1_conversations_append_stream

> models::ConversationEvents agents_api_v1_conversations_append_stream(conversation_id, conversation_append_stream_request)
Append new entries to an existing conversation.

Run completion on the history of the conversation and the user entries. Return the new created entries.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**conversation_id** | **String** | ID of the conversation to which we append entries. | [required] |
**conversation_append_stream_request** | [**ConversationAppendStreamRequest**](ConversationAppendStreamRequest.md) |  | [required] |

### Return type

[**models::ConversationEvents**](ConversationEvents.md)

### Authorization

[ApiKey](../README.md#ApiKey)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/event-stream, application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## agents_api_v1_conversations_delete

> agents_api_v1_conversations_delete(conversation_id)
Delete a conversation.

Delete a conversation given a conversation_id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**conversation_id** | **String** | ID of the conversation from which we are fetching metadata. | [required] |

### Return type

 (empty response body)

### Authorization

[ApiKey](../README.md#ApiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## agents_api_v1_conversations_get

> models::ResponseV1ConversationsGet agents_api_v1_conversations_get(conversation_id)
Retrieve a conversation information.

Given a conversation_id retrieve a conversation entity with its attributes.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**conversation_id** | **String** | ID of the conversation from which we are fetching metadata. | [required] |

### Return type

[**models::ResponseV1ConversationsGet**](Response_V1_Conversations_Get.md)

### Authorization

[ApiKey](../README.md#ApiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## agents_api_v1_conversations_history

> models::ConversationHistory agents_api_v1_conversations_history(conversation_id)
Retrieve all entries in a conversation.

Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**conversation_id** | **String** | ID of the conversation from which we are fetching entries. | [required] |

### Return type

[**models::ConversationHistory**](ConversationHistory.md)

### Authorization

[ApiKey](../README.md#ApiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## agents_api_v1_conversations_list

> Vec<models::ResponseV1ConversationsListInner> agents_api_v1_conversations_list(page, page_size, metadata)
List all created conversations.

Retrieve a list of conversation entities sorted by creation time.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> |  |  |[default to 0]
**page_size** | Option<**i32**> |  |  |[default to 100]
**metadata** | Option<[**models::AnyOfLessThanMapCommaNullGreaterThan**](Models__AnyOfLessThanMapCommaNullGreaterThan.md)> |  |  |

### Return type

[**Vec<models::ResponseV1ConversationsListInner>**](Response_V1_Conversations_List_inner.md)

### Authorization

[ApiKey](../README.md#ApiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## agents_api_v1_conversations_messages

> models::ConversationMessages agents_api_v1_conversations_messages(conversation_id)
Retrieve all messages in a conversation.

Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**conversation_id** | **String** | ID of the conversation from which we are fetching messages. | [required] |

### Return type

[**models::ConversationMessages**](ConversationMessages.md)

### Authorization

[ApiKey](../README.md#ApiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## agents_api_v1_conversations_restart

> models::ConversationResponse agents_api_v1_conversations_restart(conversation_id, conversation_restart_request)
Restart a conversation starting from a given entry.

Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**conversation_id** | **String** | ID of the original conversation which is being restarted. | [required] |
**conversation_restart_request** | [**ConversationRestartRequest**](ConversationRestartRequest.md) |  | [required] |

### Return type

[**models::ConversationResponse**](ConversationResponse.md)

### Authorization

[ApiKey](../README.md#ApiKey)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## agents_api_v1_conversations_restart_stream

> models::ConversationEvents agents_api_v1_conversations_restart_stream(conversation_id, conversation_restart_stream_request)
Restart a conversation starting from a given entry.

Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**conversation_id** | **String** | ID of the original conversation which is being restarted. | [required] |
**conversation_restart_stream_request** | [**ConversationRestartStreamRequest**](ConversationRestartStreamRequest.md) |  | [required] |

### Return type

[**models::ConversationEvents**](ConversationEvents.md)

### Authorization

[ApiKey](../README.md#ApiKey)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/event-stream, application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## agents_api_v1_conversations_start

> models::ConversationResponse agents_api_v1_conversations_start(conversation_request)
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.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**conversation_request** | [**ConversationRequest**](ConversationRequest.md) |  | [required] |

### Return type

[**models::ConversationResponse**](ConversationResponse.md)

### Authorization

[ApiKey](../README.md#ApiKey)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## agents_api_v1_conversations_start_stream

> models::ConversationEvents agents_api_v1_conversations_start_stream(conversation_stream_request)
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.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**conversation_stream_request** | [**ConversationStreamRequest**](ConversationStreamRequest.md) |  | [required] |

### Return type

[**models::ConversationEvents**](ConversationEvents.md)

### Authorization

[ApiKey](../README.md#ApiKey)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/event-stream, application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)