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

# \BatchApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**jobs_api_routes_batch_cancel_batch_job**](BatchApi.md#jobs_api_routes_batch_cancel_batch_job) | **POST** /v1/batch/jobs/{job_id}/cancel | Cancel Batch Job
[**jobs_api_routes_batch_create_batch_job**](BatchApi.md#jobs_api_routes_batch_create_batch_job) | **POST** /v1/batch/jobs | Create Batch Job
[**jobs_api_routes_batch_get_batch_job**](BatchApi.md#jobs_api_routes_batch_get_batch_job) | **GET** /v1/batch/jobs/{job_id} | Get Batch Job
[**jobs_api_routes_batch_get_batch_jobs**](BatchApi.md#jobs_api_routes_batch_get_batch_jobs) | **GET** /v1/batch/jobs | Get Batch Jobs



## jobs_api_routes_batch_cancel_batch_job

> models::BatchJobOut jobs_api_routes_batch_cancel_batch_job(job_id)
Cancel Batch Job

Request the cancellation of a batch job.

### Parameters


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

### Return type

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


## jobs_api_routes_batch_create_batch_job

> models::BatchJobOut jobs_api_routes_batch_create_batch_job(batch_job_in)
Create Batch Job

Create a new batch job, it will be queued for processing.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**batch_job_in** | [**BatchJobIn**](BatchJobIn.md) |  | [required] |

### Return type

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


## jobs_api_routes_batch_get_batch_job

> models::BatchJobOut jobs_api_routes_batch_get_batch_job(job_id, inline)
Get Batch Job

Get a batch job details by its UUID.  Args:     inline: If True, return results inline in the response.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**job_id** | **uuid::Uuid** |  | [required] |
**inline** | Option<**bool**> |  |  |

### Return type

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


## jobs_api_routes_batch_get_batch_jobs

> models::BatchJobsOut jobs_api_routes_batch_get_batch_jobs(page, page_size, model, agent_id, metadata, created_after, created_by_me, status, order_by)
Get Batch Jobs

Get a list of batch jobs for your organization and user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> |  |  |[default to 0]
**page_size** | Option<**i32**> |  |  |[default to 100]
**model** | Option<**String**> |  |  |
**agent_id** | Option<**String**> |  |  |
**metadata** | Option<[**std::collections::HashMap<String, serde_json::Value>**](SerdeJson__Value.md)> |  |  |
**created_after** | Option<**String**> |  |  |
**created_by_me** | Option<**bool**> |  |  |[default to false]
**status** | Option<[**Vec<models::BatchJobStatus>**](Models__BatchJobStatus.md)> |  |  |
**order_by** | Option<**String**> |  |  |[default to -created]

### Return type

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