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

# \BetaLibrariesApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**libraries_create_v1**](BetaLibrariesApi.md#libraries_create_v1) | **POST** /v1/libraries | Create a new Library.
[**libraries_delete_v1**](BetaLibrariesApi.md#libraries_delete_v1) | **DELETE** /v1/libraries/{library_id} | Delete a library and all of it's document.
[**libraries_get_v1**](BetaLibrariesApi.md#libraries_get_v1) | **GET** /v1/libraries/{library_id} | Detailed information about a specific Library.
[**libraries_list_v1**](BetaLibrariesApi.md#libraries_list_v1) | **GET** /v1/libraries | List all libraries you have access to.
[**libraries_update_v1**](BetaLibrariesApi.md#libraries_update_v1) | **PUT** /v1/libraries/{library_id} | Update a library.



## libraries_create_v1

> models::LibraryOut libraries_create_v1(library_in)
Create a new Library.

Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**library_in** | [**LibraryIn**](LibraryIn.md) |  | [required] |

### Return type

[**models::LibraryOut**](LibraryOut.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)


## libraries_delete_v1

> models::LibraryOut libraries_delete_v1(library_id)
Delete a library and all of it's document.

Given a library id, deletes it together with all documents that have been uploaded to that library.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**library_id** | **uuid::Uuid** |  | [required] |

### Return type

[**models::LibraryOut**](LibraryOut.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)


## libraries_get_v1

> models::LibraryOut libraries_get_v1(library_id)
Detailed information about a specific Library.

Given a library id, details information about that Library.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**library_id** | **uuid::Uuid** |  | [required] |

### Return type

[**models::LibraryOut**](LibraryOut.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)


## libraries_list_v1

> models::ListLibraryOut libraries_list_v1()
List all libraries you have access to.

List all libraries that you have created or have been shared with you.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::ListLibraryOut**](ListLibraryOut.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)


## libraries_update_v1

> models::LibraryOut libraries_update_v1(library_id, library_in_update)
Update a library.

Given a library id, you can update the name and description.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**library_id** | **uuid::Uuid** |  | [required] |
**library_in_update** | [**LibraryInUpdate**](LibraryInUpdate.md) |  | [required] |

### Return type

[**models::LibraryOut**](LibraryOut.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)