openapi: 3.1.0
info:
title: Mistral AI API
description: 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.
version: 1.0.0
paths:
/v1/models:
get:
summary: List Models
description: List all models available to the user.
operationId: list_models_v1_models_get
parameters:
- name: provider
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Provider
- name: model
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Model
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ModelList'
examples:
userExample:
value:
- id:
Carnegie Mellon University
sgarg2@andrew.cmu.edu
Sivaraman Balakrishnan
Carnegie Mellon University
sbalakri@andrew.cmu.edu
Zachary C. Lipton
Carnegie Mellon University
zlipton@andrew.cmu.edu
## Behnam Neyshabur
Google Research, Blueshift team
neyshabur@google.com
Hanie Sedghi
Google Research, Brain team
hsedghi@google.com
#### Abstract
Real-world machine learning deployments are characterized by mismatches between the source (training) and target (test) distributions that may cause performance drops. In this work, we investigate methods for predicting the target domain accuracy using only labeled source data and unlabeled target data. We propose Average Thresholded Confidence (ATC), a practical method that learns a threshold on the model''s confidence, predicting accuracy as the fraction of unlabeled examples for which model confidence exceeds that threshold. ATC outperforms previous methods across several model architectures, types of distribution shifts (e.g., due to synthetic corruptions, dataset reproduction, or novel subpopulations), and datasets (WILDS, ImageNet, BREEDS, CIFAR, and MNIST). In our experiments, ATC estimates target performance $2-4 \times$ more accurately than prior methods. We also explore the theoretical foundations of the problem, proving that, in general, identifying the
accuracy is just as hard as identifying the optimal predictor and thus, the efficacy of any method rests upon (perhaps unstated) assumptions on the nature of the shift. Finally, analyzing our method on some toy distributions, we provide insights concerning when it works ${ }^{1}$.
## 1 INTRODUCTION
Machine learning models deployed in the real world typically encounter examples from previously unseen distributions. While the IID assumption enables us to evaluate models using held-out data from the source distribution (from which training data is sampled), this estimate is no longer valid in presence of a distribution shift. Moreover, under such shifts, model accuracy tends to degrade (Szegedy et al., 2014; Recht et al., 2019; Koh et al., 2021). Commonly, the only data available to the practitioner are a labeled training set (source) and unlabeled deployment-time data which makes the problem more difficult. In this setting, detecting shifts in the distribution of covariates is known to be possible (but difficult) in theory (Ramdas et al., 2015), and in practice (Rabanser et al., 2018). However, producing an optimal predictor using only labeled source and unlabeled target data is well-known to be impossible absent further assumptions (Ben-David et al., 2010; Lipton
et al., 2018).
Two vital questions that remain are: (i) the precise conditions under which we can estimate a classifier''s target-domain accuracy; and (ii) which methods are most practically useful. To begin, the straightforward way to assess the performance of a model under distribution shift would be to collect labeled (target domain) examples and then to evaluate the model on that data. However, collecting fresh labeled data from the target distribution is prohibitively expensive and time-consuming, especially if the target distribution is non-stationary. Hence, instead of using labeled data, we aim to use unlabeled data from the target distribution, that is comparatively abundant, to predict model performance. Note that in this work, our focus is not to improve performance on the target but, rather, to estimate the accuracy on the target for a given classifier.
[^0]: Work done in part while Saurabh Garg was interning at Google ${ }^{1}$ Code is available at [https://github.com/saurabhgarg1996/ATC_code](https://github.com/saurabhgarg1996/ATC_code).
'
images: []
dimensions:
dpi: 200
height: 2200
width: 1700
- index: 2
markdown: '
Figure 1: Illustration of our proposed method ATC. Left: using source domain validation data, we identify a threshold on a score (e.g. negative entropy) computed on model confidence such that fraction of examples above the threshold matches the validation set accuracy. ATC estimates accuracy on unlabeled target data as the fraction of examples with the score above the threshold. Interestingly, this threshold yields accurate estimates on a wide set of target distributions resulting from natural and synthetic shifts. Right: Efficacy of ATC over previously proposed approaches on our testbed with a post-hoc calibrated model. To obtain errors on the same scale, we rescale all errors with Average Confidence (AC) error. Lower estimation error is better. See Table 1 for exact numbers and comparison on various types of distribution shift. See Sec. 5 for details on our testbed.
Recently, numerous methods have been proposed for this purpose (Deng & Zheng, 2021; Chen et al., 2021b; Jiang et al., 2021; Deng et al., 2021; Guillory et al., 2021). These methods either require calibration on the target domain to yield consistent estimates (Jiang et al., 2021; Guillory et al., 2021) or additional labeled data from several target domains to learn a linear regression function on a distributional distance that then predicts model performance (Deng et al., 2021; Deng & Zheng, 2021; Guillory et al., 2021). However, methods that require calibration on the target domain typically yield poor estimates since deep models trained and calibrated on source data are not, in general, calibrated on a (previously unseen) target domain (Ovadia et al., 2019). Besides, methods that leverage labeled data from target domains rely on the fact that unseen target domains exhibit strong linear correlation with seen target domains on the underlying distance measure and, hence,
can be rendered ineffective when such target domains with labeled data are unavailable (in Sec. 5.1 we demonstrate such a failure on a real-world distribution shift problem). Therefore, throughout the paper, we assume access to labeled source data and only unlabeled data from target domain(s).
In this work, we first show that absent assumptions on the source classifier or the nature of the shift, no method of estimating accuracy will work generally (even in non-contrived settings). To estimate accuracy on target domain perfectly, we highlight that even given perfect knowledge of the labeled source distribution (i.e., $p_{s}(x, y)$ ) and unlabeled target distribution (i.e., $p_{t}(x)$ ), we need restrictions on the nature of the shift such that we can uniquely identify the target conditional $p_{t}(y \mid x)$. Thus, in general, identifying the accuracy of the classifier is as hard as identifying the optimal predictor.
Second, motivated by the superiority of methods that use maximum softmax probability (or logit) of a model for Out-Of-Distribution (OOD) detection (Hendrycks & Gimpel, 2016; Hendrycks et al., 2019), we propose a simple method that leverages softmax probability to predict model performance. Our method, Average Thresholded Confidence (ATC), learns a threshold on a score (e.g., maximum confidence or negative entropy) of model confidence on validation source data and predicts target domain accuracy as the fraction of unlabeled target points that receive a score above that threshold. ATC selects a threshold on validation source data such that the fraction of source examples that receive the score above the threshold match the accuracy of those examples. Our primary contribution in ATC is the proposal of obtaining the threshold and observing its efficacy on (practical) accuracy estimation. Importantly, our work takes a step forward in positively answering the question raised
in Deng & Zheng (2021); Deng et al. (2021) about a practical strategy to select a threshold that enables accuracy prediction with thresholded model confidence.
'
images:
- id: img-0.jpeg
top_left_x: 292
top_left_y: 217
bottom_right_x: 1405
bottom_right_y: 649
image_base64: '...'
dimensions:
dpi: 200
height: 2200
width: 1700
- index: 3
markdown: '...'
images: []
dimensions: {}
- index: 27
markdown: '
Figure 9: Scatter plot of predicted accuracy versus (true) OOD accuracy for vision datasets except MNIST with a ResNet50 model. Results reported by aggregating MAE numbers over 4 different seeds.
'
images:
- id: img-8.jpeg
top_left_x: 290
top_left_y: 226
bottom_right_x: 1405
bottom_right_y: 1834
image_base64: '...'
dimensions:
dpi: 200
height: 2200
width: 1700
- index: 28
markdown: '| Dataset | Shift | IM | | AC | | DOC | | GDE | ATC-MC (Ours) | | ATC-NE (Ours) | | | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | | | | Pre T | Post T | Pre T | Post T | Pre T | Post T | Post T | Pre T | Post T | Pre T | Post T | | CIFAR10 | Natural | 6.60 | 5.74 | 9.88 | 6.89 | 7.25 | 6.07 | 4.77 | 3.21 | 3.02 | 2.99 | 2.85 | | | | (0.35) | (0.30) | (0.16) | (0.13) | (0.15) | (0.16) | (0.13) | (0.49) | (0.40) | (0.37) | (0.29) | | | Synthetic | 12.33 | 10.20 | 16.50 | 11.91 | 13.87 | 11.08 | 6.55 | 4.65 | 4.25 | 4.21 | 3.87 | | | | (0.51) | (0.48) | (0.26) | (0.17) | (0.18) | (0.17) | (0.35) | (0.55) | (0.55) | (0.55) | (0.75) | | CIFAR100 | Synthetic | 13.69 | 11.51 | 23.61 | 13.10 | 14.60 | 10.14 | 9.85 | 5.50 | 4.75 | 4.72 | 4.94 | | | | (0.55) | (0.41) | (1.16) | (0.80) | (0.77) | (0.64) | (0.57) | (0.70) | (0.73) | (0.74) | (0.74) | | ImageNet200 | Natural | 12.37 | 8.19 | 22.07 | 8.61 | 15.17
| 7.81 | 5.13 | 4.37 | 2.04 | 3.79 | 1.45 | | | | (0.25) | (0.33) | (0.08) | (0.25) | (0.11) | (0.29) | (0.08) | (0.39) | (0.24) | (0.30) | (0.27) | | | Synthetic | 19.86 | 12.94 | 32.44 | 13.35 | 25.02 | 12.38 | 5.41 | 5.93 | 3.09 | 5.00 | 2.68 | | | | (1.38) | (1.81) | (1.00) | (1.30) | (1.10) | (1.38) | (0.89) | (1.38) | (0.87) | (1.28) | (0.45) | | ImageNet | Natural | 7.77 | 6.50 | 18.13 | 6.02 | 8.13 | 5.76 | 6.23 | 3.88 | 2.17 | 2.06 | 0.80 | | | | (0.27) | (0.33) | (0.23) | (0.34) | (0.27) | (0.37) | (0.41) | (0.53) | (0.62) | (0.54) | (0.44) | | | Synthetic | 13.39 | 10.12 | 24.62 | 8.51 | 13.55 | 7.90 | 6.32 | 3.34 | 2.53 | 2.61 | 4.89 | | | | (0.53) | (0.63) | (0.64) | (0.71) | (0.61) | (0.72) | (0.33) | (0.53) | (0.36) | (0.33) | (0.83) | | FMoW-WILDS | Natural | 5.53 | 4.31 | 33.53 | 12.84 | 5.94 | 4.45 | 5.74 | 3.06 | 2.70 | 3.02 | 2.72 | | | | (0.33) | (0.63) | (0.13) | (12.06) | (0.36) | (0.77) | (0.55) | (0.36) | (0.54) | (0.35) | (0.44)
| | RxRx1-WILDS | Natural | 5.80 | 5.72 | 7.90 | 4.84 | 5.98 | 5.98 | 6.03 | 4.66 | 4.56 | 4.41 | 4.47 | | | | (0.17) | (0.15) | (0.24) | (0.09) | (0.15) | (0.13) | (0.08) | (0.38) | (0.38) | (0.31) | (0.26) | | Amazon-WILDS | Natural | 2.40 | 2.29 | 8.01 | 2.38 | 2.40 | 2.28 | 17.87 | 1.65 | 1.62 | 1.60 | 1.59 | | | | (0.08) | (0.09) | (0.53) | (0.17) | (0.09) | (0.09) | (0.18) | (0.06) | (0.05) | (0.14) | (0.15) | | CivilCom.-WILDS | Natural | 12.64 | 10.80 | 16.76 | 11.03 | 13.31 | 10.99 | 16.65 | | 7.14 | | | | | | (0.52) | (0.48) | (0.53) | (0.49) | (0.52) | (0.49) | (0.25) | | (0.41) | | | | MNIST | Natural | 18.48 | 15.99 | 21.17 | 14.81 | 20.19 | 14.56 | 24.42 | 5.02 | 2.40 | 3.14 | 3.50 | | | | (0.45) | (1.53) | (0.24) | (3.89) | (0.23) | (3.47) | (0.41) | (0.44) | (1.83) | (0.49) | (0.17) | | ENTITY-13 | Same | 16.23 | 11.14 | 24.97 | 10.88 | 19.08 | 10.47 | 10.71 | 5.39 | 3.88 | 4.58 | 4.19 | | | | (0.77) | (0.65) | (0.70) | (0.77) | (0.65)
| (0.72) | (0.74) | (0.92) | (0.61) | (0.85) | (0.16) | | | Novel | 28.53 | 22.02 | 38.33 | 21.64 | 32.43 | 21.22 | 20.61 | 13.58 | 10.28 | 12.25 | 6.63 | | | | (0.82) | (0.68) | (0.75) | (0.86) | (0.69) | (0.80) | (0.60) | (1.15) | (1.34) | (1.21) | (0.93) | | ENTITY-30 | Same | 18.59 | 14.46 | 28.82 | 14.30 | 21.63 | 13.46 | 12.92 | 9.12 | 7.75 | 8.15 | 7.64 | | | | (0.51) | (0.52) | (0.43) | (0.71) | (0.37) | (0.59) | (0.14) | (0.62) | (0.72) | (0.68) | (0.88) | | | Novel | 32.34 | 26.85 | 44.02 | 26.27 | 36.82 | 25.42 | 23.16 | 17.75 | 14.30 | 15.60 | 10.57 | | | | (0.60) | (0.58) | (0.56) | (0.79) | (0.47) | (0.68) | (0.12) | (0.76) | (0.85) | (0.86) | (0.86) | | NONLIVING-26 | Same | 18.66 | 17.17 | 26.39 | 16.14 | 19.86 | 15.58 | 16.63 | 10.87 | 10.24 | 10.07 | 10.26 | | | | (0.76) | (0.74) | (0.82) | (0.81) | (0.67) | (0.76) | (0.45) | (0.98) | (0.83) | (0.92) | (1.18) | | | Novel | 33.43 | 31.53 | 41.66 | 29.87 | 35.13 | 29.31 | 29.56 | 21.70 |
20.12 | 19.08 | 18.26 | | | | (0.67) | (0.65) | (0.67) | (0.71) | (0.54) | (0.64) | (0.21) | (0.86) | (0.75) | (0.82) | (1.12) | | LIVING-17 | Same | 12.63 | 11.05 | 18.32 | 10.46 | 14.43 | 10.14 | 9.87 | 4.57 | 3.95 | 3.81 | 4.21 | | | | (1.25) | (1.20) | (1.01) | (1.12) | (1.11) | (1.16) | (0.61) | (0.71) | (0.48) | (0.22) | (0.53) | | | Novel | 29.03 | 26.96 | 35.67 | 26.11 | 31.73 | 25.73 | 23.53 | 16.15 | 14.49 | 12.97 | 11.39 | | | | (1.44) | (1.38) | (1.09) | (1.27) | (1.19) | (1.35) | (0.52) | (1.36) | (1.46) | (1.52) | (1.72) |
Table 3: Mean Absolute estimation Error (MAE) results for different datasets in our setup grouped by the nature of shift. ''Same'' refers to same subpopulation shifts and ''Novel'' refers novel subpopulation shifts. We include details about the target sets considered in each shift in Table 2. Post T denotes use of TS calibration on source. For language datasets, we use DistilBERT-base-uncased, for vision dataset we report results with DenseNet model with the exception of MNIST where we use FCN. Across all datasets, we observe that ATC achieves superior performance (lower MAE is better). For GDE post T and pre T estimates match since TS doesn''t alter the argmax prediction. Results reported by aggregating MAE numbers over 4 different seeds. Values in parenthesis (i.e., $(\cdot)$ ) denote standard deviation values.
'
images: []
dimensions:
dpi: 200
height: 2200
width: 1700
- index: 29
markdown: '| Dataset | Shift | IM | | AC | | DOC | | GDE | ATC-MC (Ours) | | ATC-NE (Ours) | | | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | | | | Pre T | Post T | Pre T | Post T | Pre T | Post T | Post T | Pre T | Post T | Pre T | Post T | | CIFAR10 | Natural | 7.14 | 6.20 | 10.25 | 7.06 | 7.68 | 6.35 | 5.74 | 4.02 | 3.85 | 3.76 | 3.38 | | | | (0.14) | (0.11) | (0.31) | (0.33) | (0.28) | (0.27) | (0.25) | (0.38) | (0.30) | (0.33) | (0.32) | | | Synthetic | 12.62 | 10.75 | 16.50 | 11.91 | 13.93 | 11.20 | 7.97 | 5.66 | 5.03 | 4.87 | 3.63 | | | | (0.76) | (0.71) | (0.28) | (0.24) | (0.29) | (0.28) | (0.13) | (0.64) | (0.71) | (0.71) | (0.62) | | CIFAR100 | Synthetic | 12.77 | 12.34 | 16.89 | 12.73 | 11.18 | 9.63 | 12.00 | 5.61 | 5.55 | 5.65 | 5.76 | | | | (0.43) | (0.68) | (0.20) | (2.59) | (0.35) | (1.25) | (0.48) | (0.51) | (0.55) | (0.35) | (0.27) | | ImageNet200 | Natural | 12.63 | 7.99 | 23.08 | 7.22 |
15.40 | 6.33 | 5.00 | 4.60 | 1.80 | 4.06 | 1.38 | | | | (0.59) | (0.47) | (0.31) | (0.22) | (0.42) | (0.24) | (0.36) | (0.63) | (0.17) | (0.69) | (0.29) | | | Synthetic | 20.17 | 11.74 | 33.69 | 9.51 | 25.49 | 8.61 | 4.19 | 5.37 | 2.78 | 4.53 | 3.58 | | | | (0.74) | (0.80) | (0.73) | (0.51) | (0.66) | (0.50) | (0.14) | (0.88) | (0.23) | (0.79) | (0.33) | | ImageNet | Natural | 8.09 | 6.42 | 21.66 | 5.91 | 8.53 | 5.21 | 5.90 | 3.93 | 1.89 | 2.45 | 0.73 | | | | (0.25) | (0.28) | (0.38) | (0.22) | (0.26) | (0.25) | (0.44) | (0.26) | (0.21) | (0.16) | (0.10) | | | Synthetic | 13.93 | 9.90 | 28.05 | 7.56 | 13.82 | 6.19 | 6.70 | 3.33 | 2.55 | 2.12 | 5.06 | | | | (0.14) | (0.23) | (0.39) | (0.13) | (0.31) | (0.07) | (0.52) | (0.25) | (0.25) | (0.31) | (0.27) | | FMoW-WILDS | Natural | 5.15 | 3.55 | 34.64 | 5.03 | 5.58 | 3.46 | 5.08 | 2.59 | 2.33 | 2.52 | 2.22 | | | | (0.19) | (0.41) | (0.22) | (0.29) | (0.17) | (0.37) | (0.46) | (0.32) | (0.28) | (0.25) | (0.30)
| | RxRx1-WILDS | Natural | 6.17 | 6.11 | 21.05 | 5.21 | 6.54 | 6.27 | 6.82 | 5.30 | 5.20 | 5.19 | 5.63 | | | | (0.20) | (0.24) | (0.31) | (0.18) | (0.21) | (0.20) | (0.31) | (0.30) | (0.44) | (0.43) | (0.55) | | Entity-13 | Same | 18.32 | 14.38 | 27.79 | 13.56 | 20.50 | 13.22 | 16.09 | 9.35 | 7.50 | 7.80 | 6.94 | | | | (0.29) | (0.53) | (1.18) | (0.58) | (0.47) | (0.58) | (0.84) | (0.79) | (0.65) | (0.62) | (0.71) | | | Novel | 28.82 | 24.03 | 38.97 | 22.96 | 31.66 | 22.61 | 25.26 | 17.11 | 13.96 | 14.75 | 9.94 | | | | (0.30) | (0.55) | (1.32) | (0.59) | (0.54) | (0.58) | (1.08) | (0.93) | (0.64) | (0.78) | | | Entity-30 | Same | 16.91 | 14.61 | 26.84 | 14.37 | 18.60 | 13.11 | 13.74 | 8.54 | 7.94 | 7.77 | 8.04 | | | | (1.33) | (1.11) | (2.15) | (1.34) | (1.69) | (1.30) | (1.07) | (1.47) | (1.38) | (1.44) | (1.51) | | | Novel | 28.66 | 25.83 | 39.21 | 25.03 | 30.95 | 23.73 | 23.15 | 15.57 | 13.24 | 12.44 | 11.05 | | | | (1.16) | (0.88) | (2.03) | (1.11)
| (1.64) | (1.11) | (0.51) | (1.44) | (1.15) | (1.26) | (1.13) | | NonLIVING-26 | Same | 17.43 | 15.95 | 27.70 | 15.40 | 18.06 | 14.58 | 16.99 | 10.79 | 10.13 | 10.05 | 10.29 | | | | (0.90) | (0.86) | (0.90) | (0.69) | (1.00) | (0.78) | (1.25) | (0.62) | (0.32) | (0.46) | (0.79) | | | Novel | 29.51 | 27.75 | 40.02 | 26.77 | 30.36 | 25.93 | 27.70 | 19.64 | 17.75 | 16.90 | 15.69 | | | | (0.86) | (0.82) | (0.76) | (0.82) | (0.95) | (0.80) | (1.42) | (0.68) | (0.53) | (0.60) | (0.83) | | LIVING-17 | Same | 14.28 | 12.21 | 23.46 | 11.16 | 15.22 | 10.78 | 10.49 | 4.92 | 4.23 | 4.19 | 4.73 | | | | (0.96) | (0.93) | (1.16) | (0.90) | (0.96) | (0.99) | (0.97) | (0.57) | (0.42) | (0.35) | (0.24) | | | Novel | 28.91 | 26.35 | 38.62 | 24.91 | 30.32 | 24.52 | 22.49 | 15.42 | 13.02 | 12.29 | 10.34 | | | | (0.66) | (0.73) | (1.01) | (0.61) | (0.59) | (0.74) | (0.85) | (0.59) | (0.53) | (0.73) | (0.62) |
Table 4: Mean Absolute estimation Error (MAE) results for different datasets in our setup grouped by the nature of shift for ResNet model. ''Same'' refers to same subpopulation shifts and ''Novel'' refers novel subpopulation shifts. We include details about the target sets considered in each shift in Table 2. Post T denotes use of TS calibration on source. Across all datasets, we observe that ATC achieves superior performance (lower MAE is better). For GDE post T and pre T estimates match since TS doesn''t alter the argmax prediction. Results reported by aggregating MAE numbers over 4 different seeds. Values in parenthesis (i.e., $(\cdot)$ ) denote standard deviation values.
'
images: []
dimensions:
dpi: 200
height: 2200
width: 1700
model: mistral-ocr-2503-completion
usage_info:
pages_processed: 29
doc_size_bytes: null
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/classifications:
post:
operationId: classifications_v1_classifications_post
summary: Classifications
tags:
- classifiers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/chat/classifications:
post:
operationId: chat_classifications_v1_chat_classifications_post
summary: Chat Classifications
tags:
- classifiers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChatClassificationRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/audio/transcriptions:
post:
operationId: audio_api_v1_transcriptions_post
summary: Create Transcription
tags:
- audio.transcriptions
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/AudioTranscriptionRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TranscriptionResponse'
examples:
userExample:
value:
model: voxtral-mini-2507
text: 'This week, I traveled to Chicago to deliver my final farewell address to the nation, following in the tradition of presidents before me. It was an opportunity to say thank you. Whether we''ve seen eye to eye or rarely agreed at all, my conversations with you, the American people, in living rooms, in schools, at farms and on factory floors, at diners and on distant military outposts, All these conversations are what have kept me honest, kept me inspired, and kept me going. Every day, I learned from you. You made me a better President, and you made me a better man.
Over the course of these eight years, I''ve seen the goodness, the resilience, and the hope of the American people. I''ve seen neighbors looking out for each other as we rescued our economy from the worst crisis of our lifetimes. I''ve hugged cancer survivors who finally know the security of affordable health care. I''ve seen communities like Joplin rebuild from disaster, and cities like Boston show the world that no terrorist will ever break the American spirit. I''ve seen the hopeful faces of young graduates and our newest military officers. I''ve mourned with grieving families searching for answers. And I found grace in a Charleston church. I''ve seen our scientists help a paralyzed man regain his sense of touch, and our wounded warriors walk again. I''ve seen our doctors and volunteers rebuild after earthquakes and stop pandemics in their tracks. I''ve learned from students who are building robots and curing diseases, and who will change the world in ways we can''t
even imagine. I''ve seen the youngest of children remind us of our obligations to care for our refugees, to work in peace, and above all, to look out for each other.
That''s what''s possible when we come together in the slow, hard, sometimes frustrating, but always vital work of self-government. But we can''t take our democracy for granted. All of us, regardless of party, should throw ourselves into the work of citizenship. Not just when there is an election. Not just when our own narrow interest is at stake. But over the full span of a lifetime. If you''re tired of arguing with strangers on the Internet, try to talk with one in real life. If something needs fixing, lace up your shoes and do some organizing. If you''re disappointed by your elected officials, then grab a clipboard, get some signatures, and run for office yourself.
Our success depends on our participation, regardless of which way the pendulum of power swings. It falls on each of us to be guardians of our democracy, to embrace the joyous task we''ve been given to continually try to improve this great nation of ours. Because for all our outward differences, we all share the same proud title – citizen.
It has been the honor of my life to serve you as President. Eight years later, I am even more optimistic about our country''s promise. And I look forward to working along your side as a citizen for all my days that remain.
Thanks, everybody. God bless you. And God bless the United States of America.
'
language: en
segments: []
usage:
prompt_audio_seconds: 203
prompt_tokens: 4
total_tokens: 3264
completion_tokens: 635
/v1/audio/transcriptions#stream:
post:
operationId: audio_api_v1_transcriptions_post_stream
summary: Create Streaming Transcription (SSE)
tags:
- audio.transcriptions
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/AudioTranscriptionRequestStream'
required: true
responses:
'200':
description: Stream of transcription events
content:
text/event-stream:
schema:
$ref: '#/components/schemas/TranscriptionStreamEvents'
/v1/audio/speech:
post:
summary: Speech
description: Generate speech from text using a saved voice or a reference audio clip.
operationId: speech_v1_audio_speech_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SpeechRequest'
required: true
responses:
'200':
description: Speech audio data.
content:
application/json:
schema:
$ref: '#/components/schemas/SpeechResponse'
text/event-stream:
schema:
$ref: '#/components/schemas/SpeechStreamEvents'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- audio.speech
/v1/audio/voices:
get:
operationId: list_voices_v1_audio_voices_get
summary: List all voices
description: List all voices (excluding sample data)
tags:
- audio.voices
parameters:
- name: limit
in: query
description: Maximum number of voices to return
required: false
schema:
type: integer
title: Limit
description: Maximum number of voices to return
default: 10
- name: offset
in: query
description: Offset for pagination
required: false
schema:
type: integer
title: Offset
description: Offset for pagination
default: 0
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
operationId: create_voice_v1_audio_voices_post
summary: Create a new voice
description: Create a new voice with a base64-encoded audio sample
tags:
- audio.voices
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceCreateRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/audio/voices/{voice_id}:
get:
operationId: get_voice_v1_audio_voices__voice_id__get
summary: Get voice details
description: Get voice details (excluding sample)
tags:
- audio.voices
parameters:
- name: voice_id
in: path
required: true
schema:
type: string
title: Voice Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
operationId: update_voice_v1_audio_voices__voice_id__patch
summary: Update voice metadata
description: Update voice metadata (name, gender, languages, age, tags).
tags:
- audio.voices
parameters:
- name: voice_id
in: path
required: true
schema:
type: string
title: Voice Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceUpdateRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
operationId: delete_voice_v1_audio_voices__voice_id__delete
summary: Delete a custom voice
description: Delete a custom voice
tags:
- audio.voices
parameters:
- name: voice_id
in: path
required: true
schema:
type: string
title: Voice Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/VoiceResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/audio/voices/{voice_id}/sample:
get:
operationId: get_voice_sample_audio_v1_audio_voices__voice_id__sample_get
summary: Get voice sample audio
description: Get the audio sample for a voice
tags:
- audio.voices
parameters:
- name: voice_id
in: path
required: true
schema:
type: string
title: Voice Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: string
title: Response Get Voice Sample Audio V1 Audio Voices Voice Id Sample Get
audio/wav: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/libraries:
get:
operationId: libraries_list_v1
summary: List all libraries you have access to.
description: List all libraries that you have created or have been shared with you.
tags:
- beta.libraries
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListLibraryOut'
post:
operationId: libraries_create_v1
summary: Create a new Library.
description: 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.
tags:
- beta.libraries
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LibraryIn'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LibraryOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/libraries/{library_id}:
get:
operationId: libraries_get_v1
summary: Detailed information about a specific Library.
description: Given a library id, details information about that Library.
tags:
- beta.libraries
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LibraryOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
operationId: libraries_delete_v1
summary: Delete a library and all of it's document.
description: Given a library id, deletes it together with all documents that have been uploaded to that library.
tags:
- beta.libraries
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LibraryOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
operationId: libraries_update_v1
summary: Update a library.
description: Given a library id, you can update the name and description.
tags:
- beta.libraries
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LibraryInUpdate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LibraryOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/libraries/{library_id}/documents:
get:
operationId: libraries_documents_list_v1
summary: List documents in a given library.
description: Given a library, lists the document that have been uploaded to that library.
tags:
- beta.libraries.documents
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
- name: search
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Search
- name: page_size
in: query
required: false
schema:
type: integer
title: Page Size
maximum: 100
minimum: 1
default: 100
- name: page
in: query
required: false
schema:
type: integer
title: Page
minimum: 0
default: 0
- name: filters_attributes
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Filters Attributes
- name: sort_by
in: query
required: false
schema:
type: string
title: Sort By
default: created_at
- name: sort_order
in: query
required: false
schema:
type: string
title: Sort Order
default: desc
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListDocumentOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
operationId: libraries_documents_upload_v1
summary: Upload a new document.
description: Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search
tags:
- beta.libraries.documents
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
$ref: '#/components/schemas/File'
title: DocumentUpload
required:
- file
required: true
responses:
'201':
description: Upload successful, returns the created document information's.
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentOut'
'200':
description: A document with the same hash was found in this library. Returns the existing document.
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/libraries/{library_id}/documents/{document_id}:
get:
operationId: libraries_documents_get_v1
summary: Retrieve the metadata of a specific document.
description: Given a library and a document in this library, you can retrieve the metadata of that document.
tags:
- beta.libraries.documents
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
- name: document_id
in: path
required: true
schema:
type: string
title: Document Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
operationId: libraries_documents_update_v1
summary: Update the metadata of a specific document.
description: Given a library and a document in that library, update the name of that document.
tags:
- beta.libraries.documents
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
- name: document_id
in: path
required: true
schema:
type: string
title: Document Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentUpdateIn'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
operationId: libraries_documents_delete_v1
summary: Delete a document.
description: Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index.
tags:
- beta.libraries.documents
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
- name: document_id
in: path
required: true
schema:
type: string
title: Document Id
format: uuid
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/libraries/{library_id}/documents/{document_id}/text_content:
get:
operationId: libraries_documents_get_text_content_v1
summary: Retrieve the text content of a specific document.
description: Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR.
tags:
- beta.libraries.documents
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
- name: document_id
in: path
required: true
schema:
type: string
title: Document Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentTextContent'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/libraries/{library_id}/documents/{document_id}/status:
get:
operationId: libraries_documents_get_status_v1
summary: Retrieve the processing status of a specific document.
description: Given a library and a document in that library, retrieve the processing status of that document.
tags:
- beta.libraries.documents
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
- name: document_id
in: path
required: true
schema:
type: string
title: Document Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessingStatusOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/libraries/{library_id}/documents/{document_id}/signed-url:
get:
operationId: libraries_documents_get_signed_url_v1
summary: Retrieve the signed URL of a specific document.
description: Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link.
tags:
- beta.libraries.documents
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
- name: document_id
in: path
required: true
schema:
type: string
title: Document Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: string
title: Response Libraries Documents Get Signed Url V1
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/libraries/{library_id}/documents/{document_id}/extracted-text-signed-url:
get:
operationId: libraries_documents_get_extracted_text_signed_url_v1
summary: Retrieve the signed URL of text extracted from a given document.
description: Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries.
tags:
- beta.libraries.documents
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
- name: document_id
in: path
required: true
schema:
type: string
title: Document Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: string
title: Response Libraries Documents Get Extracted Text Signed Url V1
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/libraries/{library_id}/documents/{document_id}/reprocess:
post:
operationId: libraries_documents_reprocess_v1
summary: Reprocess a document.
description: Given a library and a document in that library, reprocess that document, it will be billed again.
tags:
- beta.libraries.documents
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
- name: document_id
in: path
required: true
schema:
type: string
title: Document Id
format: uuid
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/libraries/{library_id}/share:
get:
operationId: libraries_share_list_v1
summary: List all of the access to this library.
description: Given a library, list all of the Entity that have access and to what level.
tags:
- beta.libraries.accesses
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListSharingOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
operationId: libraries_share_create_v1
summary: Create or update an access level.
description: Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization.
tags:
- beta.libraries.accesses
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SharingIn'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SharingOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
operationId: libraries_share_delete_v1
summary: Delete an access level.
description: Given a library id, you can delete the access level of an entity. An owner cannot delete it's own access. You have to be the owner of the library to delete an acces other than yours.
tags:
- beta.libraries.accesses
parameters:
- name: library_id
in: path
required: true
schema:
type: string
title: Library Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SharingDelete'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SharingOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/observability/chat-completion-events/search:
post:
operationId: get_chat_completion_events_v1_observability_chat_completion_events_search_post
summary: Get Chat Completion Events
tags:
- beta.observability.chat_completion_events
parameters:
- name: page_size
in: query
required: false
schema:
type: integer
title: Page Size
maximum: 100
minimum: 0
default: 50
- name: cursor
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Cursor
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetChatCompletionEventsInSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatCompletionEvents'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/chat-completion-events/search-ids:
post:
operationId: get_chat_completion_event_ids_v1_observability_chat_completion_events_search_ids_post
summary: Alternative to /search that returns only the IDs and that can return many IDs at once
tags:
- beta.observability.chat_completion_events
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetChatCompletionEventIdsInSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatCompletionEventIds'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/chat-completion-events/{event_id}:
get:
operationId: get_chat_completion_event_v1_observability_chat_completion_events__event_id__get
summary: Get Chat Completion Event
tags:
- beta.observability.chat_completion_events
parameters:
- name: event_id
in: path
required: true
schema:
type: string
title: Event Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatCompletionEvent'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/chat-completion-events/{event_id}/similar-events:
get:
operationId: get_similar_chat_completion_events_v1_observability_chat_completion_events__event_id__similar_events_get
summary: Get Similar Chat Completion Events
tags:
- beta.observability.chat_completion_events
parameters:
- name: event_id
in: path
required: true
schema:
type: string
title: Event Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatCompletionEvents'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/chat-completion-fields:
get:
operationId: get_chat_completion_fields_v1_observability_chat_completion_fields_get
summary: Get Chat Completion Fields
tags:
- beta.observability.chat_completion_events.fields
parameters: []
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatCompletionFields'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/chat-completion-fields/{field_name}/options:
get:
operationId: get_chat_completion_field_options_v1_observability_chat_completion_fields__field_name__options_get
summary: Get Chat Completion Field Options
tags:
- beta.observability.chat_completion_events.fields
parameters:
- name: field_name
in: path
required: true
schema:
type: string
title: Field Name
- name: operator
in: query
description: The operator to use for filtering options
required: true
schema:
type: string
title: Operator
enum:
- lt
- lte
- gt
- gte
- startswith
- istartswith
- endswith
- iendswith
- contains
- icontains
- matches
- notcontains
- inotcontains
- eq
- neq
- isnull
- includes
- excludes
- len_eq
description: The operator to use for filtering options
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ChatCompletionFieldOptions'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/chat-completion-fields/{field_name}/options-counts:
post:
operationId: get_chat_completion_field_options_counts_v1_observability_chat_completion_fields__field_name__options_counts_post
summary: Get Chat Completion Field Options Counts
tags:
- beta.observability.chat_completion_events.fields
parameters:
- name: field_name
in: path
required: true
schema:
type: string
title: Field Name
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FieldOptionCountsInSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FieldOptionCounts'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/chat-completion-events/{event_id}/live-judging:
post:
operationId: judge_chat_completion_event_v1_observability_chat_completion_events__event_id__live_judging_post
summary: Run Judge on an event based on the given options
tags:
- beta.observability.chat_completion_events
parameters:
- name: event_id
in: path
required: true
schema:
type: string
title: Event Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostChatCompletionEventJudgingInSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/JudgeOutput'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/judges:
post:
operationId: create_judge_v1_observability_judges_post
summary: Create a new judge
tags:
- beta.observability.judges
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostJudgeInSchema'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/JudgePreview'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
get:
operationId: get_judges_v1_observability_judges_get
summary: Get judges with optional filtering and search
tags:
- beta.observability.judges
parameters:
- name: type_filter
in: query
description: Filter by judge output types
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/JudgeOutputType'
- type: 'null'
title: Type Filter
description: Filter by judge output types
- name: model_filter
in: query
description: Filter by model names
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Model Filter
description: Filter by model names
- name: page_size
in: query
required: false
schema:
type: integer
title: Page Size
maximum: 100
minimum: 0
default: 50
- name: page
in: query
required: false
schema:
type: integer
title: Page
default: 1
- name: q
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Q
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/JudgePreviews'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/judges/{judge_id}:
get:
operationId: get_judge_by_id_v1_observability_judges__judge_id__get
summary: Get judge by id
tags:
- beta.observability.judges
parameters:
- name: judge_id
in: path
required: true
schema:
type: string
title: Judge Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/JudgePreview'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
delete:
operationId: delete_judge_v1_observability_judges__judge_id__delete
summary: Delete a judge
tags:
- beta.observability.judges
parameters:
- name: judge_id
in: path
required: true
schema:
type: string
title: Judge Id
format: uuid
responses:
'204':
description: Successful Response
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
put:
operationId: update_judge_v1_observability_judges__judge_id__put
summary: Update a judge
tags:
- beta.observability.judges
parameters:
- name: judge_id
in: path
required: true
schema:
type: string
title: Judge Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PutJudgeInSchema'
required: true
responses:
'204':
description: Successful Response
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/judges/{judge_id}/live-judging:
post:
operationId: judge_conversation_v1_observability_judges__judge_id__live_judging_post
summary: Run a saved judge on a conversation
tags:
- beta.observability.judges
parameters:
- name: judge_id
in: path
required: true
schema:
type: string
title: Judge Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JudgeConversationRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/JudgeOutput'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/campaigns:
post:
operationId: create_campaign_v1_observability_campaigns_post
summary: Create and start a new campaign
tags:
- beta.observability.campaigns
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostCampaignInSchema'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignPreview'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
get:
operationId: get_campaigns_v1_observability_campaigns_get
summary: Get all campaigns
tags:
- beta.observability.campaigns
parameters:
- name: page_size
in: query
required: false
schema:
type: integer
title: Page Size
maximum: 100
minimum: 0
default: 50
- name: page
in: query
required: false
schema:
type: integer
title: Page
default: 1
- name: q
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Q
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignPreviews'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/campaigns/{campaign_id}:
get:
operationId: get_campaign_by_id_v1_observability_campaigns__campaign_id__get
summary: Get campaign by id
tags:
- beta.observability.campaigns
parameters:
- name: campaign_id
in: path
required: true
schema:
type: string
title: Campaign Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignPreview'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
delete:
operationId: delete_campaign_v1_observability_campaigns__campaign_id__delete
summary: Delete a campaign
tags:
- beta.observability.campaigns
parameters:
- name: campaign_id
in: path
required: true
schema:
type: string
title: Campaign Id
format: uuid
responses:
'204':
description: Successful Response
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/campaigns/{campaign_id}/status:
get:
operationId: get_campaign_status_by_id_v1_observability_campaigns__campaign_id__status_get
summary: Get campaign status by campaign id
tags:
- beta.observability.campaigns
parameters:
- name: campaign_id
in: path
required: true
schema:
type: string
title: Campaign Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignStatus'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/campaigns/{campaign_id}/selected-events:
get:
operationId: get_campaign_selected_events_v1_observability_campaigns__campaign_id__selected_events_get
summary: Get event ids that were selected by the given campaign
tags:
- beta.observability.campaigns
parameters:
- name: campaign_id
in: path
required: true
schema:
type: string
title: Campaign Id
format: uuid
- name: page_size
in: query
required: false
schema:
type: integer
title: Page Size
maximum: 100
minimum: 0
default: 50
- name: page
in: query
required: false
schema:
type: integer
title: Page
default: 1
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignSelectedEvents'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/datasets:
post:
operationId: create_dataset_v1_observability_datasets_post
summary: Create a new empty dataset
tags:
- beta.observability.datasets
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostDatasetInSchema'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Dataset'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
get:
operationId: get_datasets_v1_observability_datasets_get
summary: List existing datasets
tags:
- beta.observability.datasets
parameters:
- name: page_size
in: query
required: false
schema:
type: integer
title: Page Size
maximum: 100
minimum: 0
default: 50
- name: page
in: query
required: false
schema:
type: integer
title: Page
default: 1
- name: q
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Q
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetPreviews'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/datasets/{dataset_id}:
get:
operationId: get_dataset_by_id_v1_observability_datasets__dataset_id__get
summary: Get dataset by id
tags:
- beta.observability.datasets
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
title: Dataset Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetPreview'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
delete:
operationId: delete_dataset_v1_observability_datasets__dataset_id__delete
summary: Delete a dataset
tags:
- beta.observability.datasets
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
title: Dataset Id
format: uuid
responses:
'204':
description: Successful Response
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
patch:
operationId: update_dataset_v1_observability_datasets__dataset_id__patch
summary: Patch dataset
tags:
- beta.observability.datasets
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
title: Dataset Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchDatasetInSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetPreview'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/datasets/{dataset_id}/records:
get:
operationId: get_dataset_records_v1_observability_datasets__dataset_id__records_get
summary: List existing records in the dataset
tags:
- beta.observability.datasets
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
title: Dataset Id
format: uuid
- name: page_size
in: query
required: false
schema:
type: integer
title: Page Size
maximum: 100
minimum: 0
default: 50
- name: page
in: query
required: false
schema:
type: integer
title: Page
default: 1
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetRecords'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
post:
operationId: create_dataset_record_v1_observability_datasets__dataset_id__records_post
summary: Add a conversation to the dataset
tags:
- beta.observability.datasets
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
title: Dataset Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostDatasetRecordInSchema'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetRecord'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/datasets/{dataset_id}/imports/from-campaign:
post:
operationId: post_dataset_records_from_campaign_v1_observability_datasets__dataset_id__imports_from_campaign_post
summary: Populate the dataset with a campaign
tags:
- beta.observability.datasets
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
title: Dataset Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostDatasetImportFromCampaignInSchema'
required: true
responses:
'202':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetImportTask'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/datasets/{dataset_id}/imports/from-explorer:
post:
operationId: post_dataset_records_from_explorer_v1_observability_datasets__dataset_id__imports_from_explorer_post
summary: Populate the dataset with samples from the explorer
tags:
- beta.observability.datasets
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
title: Dataset Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostDatasetImportFromExplorerInSchema'
required: true
responses:
'202':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetImportTask'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/datasets/{dataset_id}/imports/from-file:
post:
operationId: post_dataset_records_from_file_v1_observability_datasets__dataset_id__imports_from_file_post
summary: Populate the dataset with samples from an uploaded file
tags:
- beta.observability.datasets
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
title: Dataset Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostDatasetImportFromFileInSchema'
required: true
responses:
'202':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetImportTask'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/datasets/{dataset_id}/imports/from-playground:
post:
operationId: post_dataset_records_from_playground_v1_observability_datasets__dataset_id__imports_from_playground_post
summary: Populate the dataset with samples from the playground
tags:
- beta.observability.datasets
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
title: Dataset Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostDatasetImportFromPlaygroundInSchema'
required: true
responses:
'202':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetImportTask'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/datasets/{dataset_id}/imports/from-dataset:
post:
operationId: post_dataset_records_from_dataset_v1_observability_datasets__dataset_id__imports_from_dataset_post
summary: Populate the dataset with samples from another dataset
tags:
- beta.observability.datasets
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
title: Dataset Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostDatasetImportFromDatasetInSchema'
required: true
responses:
'202':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetImportTask'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/datasets/{dataset_id}/exports/to-jsonl:
get:
operationId: export_dataset_to_jsonl_v1_observability_datasets__dataset_id__exports_to_jsonl_get
summary: Export to the Files API and retrieve presigned URL to download the resulting JSONL file
tags:
- beta.observability.datasets
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
title: Dataset Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetExport'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/datasets/{dataset_id}/tasks/{task_id}:
get:
operationId: get_dataset_import_task_v1_observability_datasets__dataset_id__tasks__task_id__get
summary: Get status of a dataset import task
tags:
- beta.observability.datasets
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
title: Dataset Id
format: uuid
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetImportTask'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/datasets/{dataset_id}/tasks:
get:
operationId: get_dataset_import_tasks_v1_observability_datasets__dataset_id__tasks_get
summary: List import tasks for the given dataset
tags:
- beta.observability.datasets
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
title: Dataset Id
format: uuid
- name: page_size
in: query
required: false
schema:
type: integer
title: Page Size
maximum: 100
minimum: 0
default: 50
- name: page
in: query
required: false
schema:
type: integer
title: Page
default: 1
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetImportTasks'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/dataset-records/{dataset_record_id}:
get:
operationId: get_dataset_record_v1_observability_dataset_records__dataset_record_id__get
summary: Get the content of a given conversation from a dataset
tags:
- beta.observability.datasets.records
parameters:
- name: dataset_record_id
in: path
required: true
schema:
type: string
title: Dataset Record Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetRecord'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
delete:
operationId: delete_dataset_record_v1_observability_dataset_records__dataset_record_id__delete
summary: Delete a record from a dataset
tags:
- beta.observability.datasets.records
parameters:
- name: dataset_record_id
in: path
required: true
schema:
type: string
title: Dataset Record Id
format: uuid
responses:
'204':
description: Successful Response
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/dataset-records/bulk-delete:
post:
operationId: delete_dataset_records_v1_observability_dataset_records_bulk_delete_post
summary: Delete multiple records from datasets
tags:
- beta.observability.datasets.records
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDatasetRecordsInSchema'
required: true
responses:
'204':
description: Successful Response
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/dataset-records/{dataset_record_id}/live-judging:
post:
operationId: judge_dataset_record_v1_observability_dataset_records__dataset_record_id__live_judging_post
summary: Run Judge on a dataset record based on the given options
tags:
- beta.observability.datasets.records
parameters:
- name: dataset_record_id
in: path
required: true
schema:
type: string
title: Dataset Record Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostDatasetRecordJudgingInSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/JudgeOutput'
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/dataset-records/{dataset_record_id}/payload:
put:
operationId: update_dataset_record_payload_v1_observability_dataset_records__dataset_record_id__payload_put
summary: Update a dataset record conversation payload
tags:
- beta.observability.datasets.records
parameters:
- name: dataset_record_id
in: path
required: true
schema:
type: string
title: Dataset Record Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PutDatasetRecordPayloadInSchema'
required: true
responses:
'204':
description: Successful Response
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/observability/dataset-records/{dataset_record_id}/properties:
put:
operationId: update_dataset_record_properties_v1_observability_dataset_records__dataset_record_id__properties_put
summary: Update conversation properties
tags:
- beta.observability.datasets.records
parameters:
- name: dataset_record_id
in: path
required: true
schema:
type: string
title: Dataset Record Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PutDatasetRecordPropertiesInSchema'
required: true
responses:
'204':
description: Successful Response
'400':
description: Bad Request - Invalid request parameters or data
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'404':
description: Not Found - Resource does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'408':
description: Request Timeout - Operation timed out
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'409':
description: Conflict - Resource conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
'422':
description: Unprocessable Entity - Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ObservabilityError'
/v1/workflows/executions/{execution_id}:
get:
operationId: get_workflow_execution_v1_workflows_executions__execution_id__get
summary: Get Workflow Execution
tags:
- beta.workflows.executions
parameters:
- name: execution_id
in: path
required: true
schema:
type: string
title: Execution Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowExecutionResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/executions/{execution_id}/history:
get:
operationId: get_workflow_execution_history_v1_workflows_executions__execution_id__history_get
summary: Get Workflow Execution History
tags:
- beta.workflows.executions
parameters:
- name: execution_id
in: path
required: true
schema:
type: string
title: Execution Id
- name: decode_payloads
in: query
required: false
schema:
type: boolean
title: Decode Payloads
default: false
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/executions/{execution_id}/signals:
post:
operationId: signal_workflow_execution_v1_workflows_executions__execution_id__signals_post
summary: Signal Workflow Execution
tags:
- beta.workflows.executions
parameters:
- name: execution_id
in: path
required: true
schema:
type: string
title: Execution Id
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SignalInvocationBody'
required: true
responses:
'202':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SignalWorkflowResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/executions/{execution_id}/queries:
post:
operationId: query_workflow_execution_v1_workflows_executions__execution_id__queries_post
summary: Query Workflow Execution
tags:
- beta.workflows.executions
parameters:
- name: execution_id
in: path
required: true
schema:
type: string
title: Execution Id
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QueryInvocationBody'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/QueryWorkflowResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/executions/{execution_id}/terminate:
post:
operationId: terminate_workflow_execution_v1_workflows_executions__execution_id__terminate_post
summary: Terminate Workflow Execution
tags:
- beta.workflows.executions
parameters:
- name: execution_id
in: path
required: true
schema:
type: string
title: Execution Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/executions/terminate:
post:
operationId: batch_terminate_workflow_executions_v1_workflows_executions_terminate_post
summary: Batch Terminate Workflow Executions
tags:
- beta.workflows.executions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchExecutionBody'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BatchExecutionResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/executions/{execution_id}/cancel:
post:
operationId: cancel_workflow_execution_v1_workflows_executions__execution_id__cancel_post
summary: Cancel Workflow Execution
tags:
- beta.workflows.executions
parameters:
- name: execution_id
in: path
required: true
schema:
type: string
title: Execution Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/executions/cancel:
post:
operationId: batch_cancel_workflow_executions_v1_workflows_executions_cancel_post
summary: Batch Cancel Workflow Executions
tags:
- beta.workflows.executions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchExecutionBody'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BatchExecutionResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/executions/{execution_id}/reset:
post:
operationId: reset_workflow_v1_workflows_executions__execution_id__reset_post
summary: Reset Workflow
tags:
- beta.workflows.executions
parameters:
- name: execution_id
in: path
required: true
schema:
type: string
title: Execution Id
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResetInvocationBody'
required: true
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/executions/{execution_id}/updates:
post:
operationId: update_workflow_execution_v1_workflows_executions__execution_id__updates_post
summary: Update Workflow Execution
tags:
- beta.workflows.executions
parameters:
- name: execution_id
in: path
required: true
schema:
type: string
title: Execution Id
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateInvocationBody'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkflowResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/executions/{execution_id}/trace/otel:
get:
operationId: get_workflow_execution_trace_otel
summary: Get Workflow Execution Trace Otel
tags:
- beta.workflows.executions
parameters:
- name: execution_id
in: path
required: true
schema:
type: string
title: Execution Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowExecutionTraceOTelResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/executions/{execution_id}/trace/summary:
get:
operationId: get_workflow_execution_trace_summary
summary: Get Workflow Execution Trace Summary
tags:
- beta.workflows.executions
parameters:
- name: execution_id
in: path
required: true
schema:
type: string
title: Execution Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowExecutionTraceSummaryResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/executions/{execution_id}/trace/events:
get:
operationId: get_workflow_execution_trace_events
summary: Get Workflow Execution Trace Events
tags:
- beta.workflows.executions
parameters:
- name: execution_id
in: path
required: true
schema:
type: string
title: Execution Id
- name: merge_same_id_events
in: query
required: false
schema:
type: boolean
title: Merge Same Id Events
default: false
- name: include_internal_events
in: query
required: false
schema:
type: boolean
title: Include Internal Events
default: false
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowExecutionTraceEventsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/executions/{execution_id}/stream:
get:
operationId: stream_v1_workflows_executions__execution_id__stream_get
summary: Stream
tags:
- beta.workflows.executions
parameters:
- name: execution_id
in: path
required: true
schema:
type: string
title: Execution Id
- name: event_source
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/EventSource'
- type: 'null'
title: Event Source
- name: last_event_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Last Event Id
responses:
'200':
description: Stream of Server-Sent Events (SSE)
content:
text/event-stream:
schema:
type: object
properties:
event:
type: string
data:
$ref: '#/components/schemas/StreamEventSsePayload'
id:
type: string
retry:
type: integer
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/{workflow_name}/metrics:
get:
operationId: get_workflow_metrics_v1_workflows__workflow_name__metrics_get
summary: Get Workflow Metrics
description: "Get comprehensive metrics for a specific workflow.\n\nArgs:\n workflow_name: The name of the workflow type to get metrics for\n start_time: Optional start time filter (ISO 8601 format)\n end_time: Optional end time filter (ISO 8601 format)\n\nReturns:\n WorkflowMetrics: Dictionary containing metrics:\n - execution_count: Total number of executions\n - success_count: Number of successful executions\n - error_count: Number of failed/terminated executions\n - average_latency_ms: Average execution duration in milliseconds\n - retry_rate: Proportion of workflows with retries\n - latency_over_time: Time-series data of execution durations\n\nExample:\n GET /v1/workflows/MyWorkflow/metrics\n GET /v1/workflows/MyWorkflow/metrics?start_time=2025-01-01T00:00:00Z\n GET /v1/workflows/MyWorkflow/metrics?start_time=2025-01-01T00:00:00Z&end_time=2025-12-31T23:59:59Z"
tags:
- beta.workflows.metrics
parameters:
- name: workflow_name
in: path
required: true
schema:
type: string
title: Workflow Name
- name: start_time
in: query
description: Filter workflows started after this time (ISO 8601)
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Time
description: Filter workflows started after this time (ISO 8601)
- name: end_time
in: query
description: Filter workflows started before this time (ISO 8601)
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Time
description: Filter workflows started before this time (ISO 8601)
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowMetrics'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/runs:
get:
operationId: list_runs_v1_workflows_runs_get
summary: List Runs
tags:
- beta.workflows.runs
parameters:
- name: workflow_identifier
in: query
description: Filter by workflow name or id
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Workflow Identifier
description: Filter by workflow name or id
- name: search
in: query
description: Search by workflow name, display name or id
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Search
description: Search by workflow name, display name or id
- name: status
in: query
description: Filter by workflow status
required: false
schema:
anyOf:
- $ref: '#/components/schemas/WorkflowExecutionStatus'
- type: array
items:
$ref: '#/components/schemas/WorkflowExecutionStatus'
- type: 'null'
title: Status
description: Filter by workflow status
- name: page_size
in: query
description: Number of items per page
required: false
schema:
type: integer
title: Page Size
maximum: 1000
minimum: 1
description: Number of items per page
default: 50
- name: next_page_token
in: query
description: Token for the next page of results
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Next Page Token
description: Token for the next page of results
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowExecutionListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-speakeasy-pagination:
type: cursor
inputs:
- name: next_page_token
in: parameters
type: cursor
- name: page_size
in: parameters
type: limit
outputs:
results: $.executions
nextCursor: $.next_page_token
/v1/workflows/runs/{run_id}:
get:
operationId: get_run_v1_workflows_runs__run_id__get
summary: Get Run
tags:
- beta.workflows.runs
parameters:
- name: run_id
in: path
required: true
schema:
type: string
title: Run Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowExecutionResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/runs/{run_id}/history:
get:
operationId: get_run_history_v1_workflows_runs__run_id__history_get
summary: Get Run History
tags:
- beta.workflows.runs
parameters:
- name: run_id
in: path
required: true
schema:
type: string
title: Run Id
format: uuid
- name: decode_payloads
in: query
required: false
schema:
type: boolean
title: Decode Payloads
default: false
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/schedules:
get:
operationId: get_schedules_v1_workflows_schedules_get
summary: Get Schedules
tags:
- beta.workflows.schedules
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowScheduleListResponse'
post:
operationId: schedule_workflow_v1_workflows_schedules_post
summary: Schedule Workflow
tags:
- beta.workflows.schedules
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowScheduleRequest'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowScheduleResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/schedules/{schedule_id}:
delete:
operationId: unschedule_workflow_v1_workflows_schedules__schedule_id__delete
summary: Unschedule Workflow
tags:
- beta.workflows.schedules
parameters:
- name: schedule_id
in: path
required: true
schema:
type: string
title: Schedule Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/workers/whoami:
get:
operationId: get_worker_info_v1_workflows_workers_whoami_get
summary: Get Worker Info
tags:
- beta.workflows.workers
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkerInfo'
/v1/workflows/events/stream:
get:
operationId: get_stream_events_v1_workflows_events_stream_get
summary: Get Stream Events
tags:
- beta.workflows.events
parameters:
- name: scope
in: query
required: false
schema:
type: string
title: Scope
enum:
- activity
- workflow
- '*'
default: '*'
- name: activity_name
in: query
required: false
schema:
type: string
title: Activity Name
default: '*'
- name: activity_id
in: query
required: false
schema:
type: string
title: Activity Id
default: '*'
- name: workflow_name
in: query
required: false
schema:
type: string
title: Workflow Name
default: '*'
- name: workflow_exec_id
in: query
required: false
schema:
type: string
title: Workflow Exec Id
default: '*'
- name: root_workflow_exec_id
in: query
required: false
schema:
type: string
title: Root Workflow Exec Id
default: '*'
- name: parent_workflow_exec_id
in: query
required: false
schema:
type: string
title: Parent Workflow Exec Id
default: '*'
- name: stream
in: query
required: false
schema:
type: string
title: Stream
default: '*'
- name: start_seq
in: query
required: false
schema:
type: integer
title: Start Seq
default: 0
- name: metadata_filters
in: query
required: false
schema:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Metadata Filters
- name: workflow_event_types
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/WorkflowEventType'
- type: 'null'
title: Workflow Event Types
- name: last-event-id
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Last-Event-Id
responses:
'200':
description: Stream of Server-Sent Events (SSE)
content:
text/event-stream:
schema:
type: object
properties:
event:
type: string
data:
$ref: '#/components/schemas/StreamEventSsePayload'
id:
type: string
retry:
type: integer
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/events/list:
get:
operationId: get_workflow_events_v1_workflows_events_list_get
summary: Get Workflow Events
tags:
- beta.workflows.events
parameters:
- name: root_workflow_exec_id
in: query
description: Execution ID of the root workflow that initiated this execution chain.
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
- name: workflow_exec_id
in: query
description: Execution ID of the workflow that emitted this event.
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
- name: workflow_run_id
in: query
description: Run ID of the workflow that emitted this event.
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Workflow Run Id
description: Run ID of the workflow that emitted this event.
- name: limit
in: query
description: Maximum number of events to return.
required: false
schema:
type: integer
title: Limit
description: Maximum number of events to return.
default: 100
- name: cursor
in: query
description: Cursor for pagination.
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Cursor
description: Cursor for pagination.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListWorkflowEventResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/deployments:
get:
operationId: list_deployments_v1_workflows_deployments_get
summary: List Deployments
tags:
- beta.workflows.deployments
parameters:
- name: active_only
in: query
required: false
schema:
type: boolean
title: Active Only
default: true
- name: workflow_name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Workflow Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/deployments/{name}:
get:
operationId: get_deployment_v1_workflows_deployments__name__get
summary: Get Deployment
tags:
- beta.workflows.deployments
parameters:
- name: name
in: path
required: true
schema:
type: string
title: Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentDetailResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/registrations:
get:
operationId: get_workflow_registrations_v1_workflows_registrations_get
summary: Get Workflow Registrations
tags:
- beta.workflows
parameters:
- name: workflow_id
in: query
description: The workflow ID to filter by
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workflow Id
description: The workflow ID to filter by
- name: task_queue
in: query
description: The task queue to filter by
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Task Queue
description: The task queue to filter by
- name: active_only
in: query
description: Whether to only return active workflows versions
required: false
schema:
type: boolean
title: Active Only
description: Whether to only return active workflows versions
default: false
- name: include_shared
in: query
description: Whether to include shared workflow versions
required: false
schema:
type: boolean
title: Include Shared
description: Whether to include shared workflow versions
default: true
- name: workflow_search
in: query
description: The workflow name to filter by
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Workflow Search
description: The workflow name to filter by
- name: archived
in: query
description: Filter by archived state. False=exclude archived, True=only archived, None=include all
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Archived
description: Filter by archived state. False=exclude archived, True=only archived, None=include all
- name: with_workflow
in: query
description: Whether to include the workflow definition
required: false
schema:
type: boolean
title: With Workflow
description: Whether to include the workflow definition
default: false
- name: available_in_chat_assistant
in: query
description: Whether to only return workflows compatible with chat assistant
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Available In Chat Assistant
description: Whether to only return workflows compatible with chat assistant
- name: limit
in: query
description: The maximum number of workflows versions to return
required: false
schema:
type: integer
title: Limit
description: The maximum number of workflows versions to return
default: 50
- name: cursor
in: query
description: The cursor for pagination
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Cursor
description: The cursor for pagination
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowRegistrationListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/{workflow_identifier}/execute:
post:
operationId: execute_workflow_v1_workflows__workflow_identifier__execute_post
summary: Execute Workflow
tags:
- beta.workflows
parameters:
- name: workflow_identifier
in: path
required: true
schema:
type: string
title: Workflow Identifier
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowExecutionRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/WorkflowExecutionResponse'
- $ref: '#/components/schemas/WorkflowExecutionSyncResponse'
title: Response Execute Workflow V1 Workflows Workflow Identifier Execute Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/registrations/{workflow_registration_id}/execute:
post:
operationId: execute_workflow_registration_v1_workflows_registrations__workflow_registration_id__execute_post
summary: Execute Workflow Registration
tags:
- beta.workflows
parameters:
- name: workflow_registration_id
in: path
required: true
schema:
type: string
title: Workflow Registration Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowExecutionRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/WorkflowExecutionResponse'
- $ref: '#/components/schemas/WorkflowExecutionSyncResponse'
title: Response Execute Workflow Registration V1 Workflows Registrations Workflow Registration Id Execute Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
deprecated: true
/v1/workflows/{workflow_identifier}:
get:
operationId: get_workflow_v1_workflows__workflow_identifier__get
summary: Get Workflow
tags:
- beta.workflows
parameters:
- name: workflow_identifier
in: path
required: true
schema:
type: string
title: Workflow Identifier
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowGetResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
operationId: update_workflow_v1_workflows__workflow_identifier__put
summary: Update Workflow
tags:
- beta.workflows
parameters:
- name: workflow_identifier
in: path
required: true
schema:
type: string
title: Workflow Identifier
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowUpdateRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowUpdateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/registrations/{workflow_registration_id}:
get:
operationId: get_workflow_registration_v1_workflows_registrations__workflow_registration_id__get
summary: Get Workflow Registration
tags:
- beta.workflows
parameters:
- name: workflow_registration_id
in: path
required: true
schema:
type: string
title: Workflow Registration Id
format: uuid
- name: with_workflow
in: query
description: Whether to include the workflow definition
required: false
schema:
type: boolean
title: With Workflow
description: Whether to include the workflow definition
default: false
- name: include_shared
in: query
description: Whether to include shared workflow versions
required: false
schema:
type: boolean
title: Include Shared
description: Whether to include shared workflow versions
default: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowRegistrationGetResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/{workflow_identifier}/archive:
put:
operationId: archive_workflow_v1_workflows__workflow_identifier__archive_put
summary: Archive Workflow
tags:
- beta.workflows
parameters:
- name: workflow_identifier
in: path
required: true
schema:
type: string
title: Workflow Identifier
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowArchiveResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/workflows/{workflow_identifier}/unarchive:
put:
operationId: unarchive_workflow_v1_workflows__workflow_identifier__unarchive_put
summary: Unarchive Workflow
tags:
- beta.workflows
parameters:
- name: workflow_identifier
in: path
required: true
schema:
type: string
title: Workflow Identifier
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowUnarchiveResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/connectors:
post:
operationId: connector_create_v1
summary: Create a new connector.
description: Create a new MCP connector. You can customize its visibility, url and auth type.
tags:
- beta.connectors
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorMCPCreate'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Connector'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
operationId: connector_list_v1
summary: List all connectors.
description: List all your custom connectors with keyset pagination and filters.
tags:
- beta.connectors
parameters:
- name: query_filters
in: query
required: false
schema:
$ref: '#/components/schemas/ConnectorsQueryFilters'
default:
fetch_user_data: false
fetch_customer_data: false
fetch_connection_secrets: false
fetch_execution_data: false
- name: cursor
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Cursor
- name: page_size
in: query
required: false
schema:
type: integer
title: Page Size
maximum: 1000
minimum: 1
default: 100
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedConnectors'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/connectors/{connector_id_or_name}/auth_url:
get:
operationId: connector_get_auth_url_v1
summary: Get the auth URL for a connector.
description: Get the OAuth2 authorization URL for a connector to initiate user authentication.
tags:
- beta.connectors
parameters:
- name: app_return_url
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: App Return Url
- name: credentials_name
in: query
required: false
schema:
anyOf:
- type: string
pattern: ^[a-zA-Z0-9_-]{1,64}$
- type: 'null'
title: Credentials Name
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AuthUrlResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/connectors/{connector_id_or_name}/tools/{tool_name}/call:
post:
operationId: connector_call_tool_v1
summary: Call Connector Tool
description: Call a tool on an MCP connector.
tags:
- beta.connectors
parameters:
- name: tool_name
in: path
required: true
schema:
type: string
title: Tool Name
- name: credentials_name
in: query
required: false
schema:
anyOf:
- type: string
pattern: ^[a-zA-Z0-9_-]{1,64}$
- type: 'null'
title: Credentials Name
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MCPToolCallRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MCPToolCallResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/connectors/{connector_id_or_name}/tools:
get:
operationId: connector_list_tools_v1
summary: List tools for a connector.
description: List all tools available for an MCP connector.
tags:
- beta.connectors
parameters:
- name: page
in: query
required: false
schema:
type: integer
title: Page
default: 1
- name: page_size
in: query
required: false
schema:
type: integer
title: Page Size
default: 100
- name: refresh
in: query
required: false
schema:
type: boolean
title: Refresh
default: false
- name: pretty
in: query
description: Return a simplified payload with only name, description, annotations, and a compact inputSchema.
required: false
schema:
type: boolean
title: Pretty
description: Return a simplified payload with only name, description, annotations, and a compact inputSchema.
default: false
- name: credentials_name
in: query
required: false
schema:
anyOf:
- type: string
pattern: ^[a-zA-Z0-9_-]{1,64}$
- type: 'null'
title: Credentials Name
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/integrations__schemas__api__tool__Tool'
- type: array
items:
$ref: '#/components/schemas/MCPTool'
- type: array
items:
type: object
additionalProperties: true
title: Response Connector List Tools V1
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/connectors/{connector_id_or_name}/authentication_methods:
get:
operationId: connector_get_authentication_methods_v1
summary: Get authentication methods for a connector.
description: Get the authentication schema for a connector. Returns the list of supported authentication methods and their required headers.
tags:
- beta.connectors
parameters:
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PublicAuthenticationMethod'
title: Response Connector Get Authentication Methods V1
/v1/connectors/{connector_id_or_name}/organization/credentials:
get:
operationId: connector_list_organization_credentials_v1
summary: List organization credentials for a connector.
description: List all credentials configured at the organization level for a given connector.
tags:
- beta.connectors
parameters:
- name: auth_type
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/OutboundAuthenticationType'
- type: 'null'
title: Auth Type
- name: fetch_default
in: query
required: false
schema:
type: boolean
title: Fetch Default
default: false
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
operationId: connector_create_or_update_organization_credentials_v1
summary: Create or update organization credentials for a connector.
description: Create or update credentials at the organization level for a given connector.
tags:
- beta.connectors
parameters:
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialsCreateOrUpdate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/connectors/{connector_id_or_name}/workspace/credentials:
get:
operationId: connector_list_workspace_credentials_v1
summary: List workspace credentials for a connector.
description: List all credentials configured at the workspace level for a given connector.
tags:
- beta.connectors
parameters:
- name: auth_type
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/OutboundAuthenticationType'
- type: 'null'
title: Auth Type
- name: fetch_default
in: query
required: false
schema:
type: boolean
title: Fetch Default
default: false
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
operationId: connector_create_or_update_workspace_credentials_v1
summary: Create or update workspace credentials for a connector.
description: Create or update credentials at the workspace level for a given connector.
tags:
- beta.connectors
parameters:
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialsCreateOrUpdate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/connectors/{connector_id_or_name}/user/credentials:
get:
operationId: connector_list_user_credentials_v1
summary: List user credentials for a connector.
description: List all credentials configured at the user level for a given connector.
tags:
- beta.connectors
parameters:
- name: auth_type
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/OutboundAuthenticationType'
- type: 'null'
title: Auth Type
- name: fetch_default
in: query
required: false
schema:
type: boolean
title: Fetch Default
default: false
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
operationId: connector_create_or_update_user_credentials_v1
summary: Create or update user credentials for a connector.
description: Create or update credentials at the user level for a given connector.
tags:
- beta.connectors
parameters:
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialsCreateOrUpdate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/connectors/{connector_id_or_name}/organization/credentials/{credentials_name}:
delete:
operationId: connector_delete_organization_credentials_v1
summary: Delete organization credentials for a connector.
description: Delete credentials at the organization level for a given connector.
tags:
- beta.connectors
parameters:
- name: credentials_name
in: path
required: true
schema:
type: string
title: Credentials Name
pattern: ^[a-zA-Z0-9_-]{1,64}$
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/connectors/{connector_id_or_name}/workspace/credentials/{credentials_name}:
delete:
operationId: connector_delete_workspace_credentials_v1
summary: Delete workspace credentials for a connector.
description: Delete credentials at the workspace level for a given connector.
tags:
- beta.connectors
parameters:
- name: credentials_name
in: path
required: true
schema:
type: string
title: Credentials Name
pattern: ^[a-zA-Z0-9_-]{1,64}$
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/connectors/{connector_id_or_name}/user/credentials/{credentials_name}:
delete:
operationId: connector_delete_user_credentials_v1
summary: Delete user credentials for a connector.
description: Delete credentials at the user level for a given connector.
tags:
- beta.connectors
parameters:
- name: credentials_name
in: path
required: true
schema:
type: string
title: Credentials Name
pattern: ^[a-zA-Z0-9_-]{1,64}$
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/connectors/{connector_id_or_name}#idOrName:
get:
operationId: connector_get_v1
summary: Get a connector.
description: Get a connector by its ID or name.
tags:
- beta.connectors
parameters:
- name: fetch_customer_data
in: query
description: Fetch the customer data associated with the connector (e.g. customer secrets / config).
required: false
schema:
type: boolean
title: Fetch Customer Data
description: Fetch the customer data associated with the connector (e.g. customer secrets / config).
default: false
- name: fetch_connection_secrets
in: query
description: Fetch the general connection secrets associated with the connector.
required: false
schema:
type: boolean
title: Fetch Connection Secrets
description: Fetch the general connection secrets associated with the connector.
default: false
- name: connector_id_or_name
in: path
required: true
schema:
type: string
title: Connector Id Or Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Connector'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/connectors/{connector_id}#id:
patch:
operationId: connector_update_v1
summary: Update a connector.
description: Update a connector by its ID.
tags:
- beta.connectors
parameters:
- name: connector_id
in: path
required: true
schema:
type: string
title: Connector Id
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorMCPUpdate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Connector'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
operationId: connector_delete_v1
summary: Delete a connector.
description: Delete a connector by its ID.
tags:
- beta.connectors
parameters:
- name: connector_id
in: path
required: true
schema:
type: string
title: Connector Id
format: uuid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
BaseModelCard:
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: model
created:
type: integer
title: Created
owned_by:
type: string
title: Owned By
default: mistralai
capabilities:
$ref: '#/components/schemas/ModelCapabilities'
name:
anyOf:
- type: string
- type: 'null'
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
max_context_length:
type: integer
title: Max Context Length
default: 32768
aliases:
items:
type: string
type: array
title: Aliases
default: []
deprecation:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Deprecation
deprecation_replacement_model:
anyOf:
- type: string
- type: 'null'
title: Deprecation Replacement Model
default_model_temperature:
anyOf:
- type: number
- type: 'null'
title: Default Model Temperature
type:
type: string
const: base
title: Type
default: base
type: object
required:
- id
- capabilities
title: BaseModelCard
DeleteModelOut:
properties:
id:
type: string
title: Id
description: The ID of the deleted model.
examples:
- ft:open-mistral-7b:587a6b29:20240514:7e773925
object:
type: string
title: Object
default: model
description: The object type that was deleted
deleted:
type: boolean
title: Deleted
default: true
description: The deletion status
examples:
- true
type: object
required:
- id
title: DeleteModelOut
FTModelCard:
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: model
created:
type: integer
title: Created
owned_by:
type: string
title: Owned By
default: mistralai
capabilities:
$ref: '#/components/schemas/ModelCapabilities'
name:
anyOf:
- type: string
- type: 'null'
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
max_context_length:
type: integer
title: Max Context Length
default: 32768
aliases:
items:
type: string
type: array
title: Aliases
default: []
deprecation:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Deprecation
deprecation_replacement_model:
anyOf:
- type: string
- type: 'null'
title: Deprecation Replacement Model
default_model_temperature:
anyOf:
- type: number
- type: 'null'
title: Default Model Temperature
type:
type: string
const: fine-tuned
title: Type
default: fine-tuned
job:
type: string
title: Job
root:
type: string
title: Root
archived:
type: boolean
title: Archived
default: false
type: object
required:
- id
- capabilities
- job
- root
title: FTModelCard
description: Extra fields for fine-tuned models.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ModelCapabilities:
properties:
completion_chat:
type: boolean
title: Completion Chat
default: false
function_calling:
type: boolean
title: Function Calling
default: false
completion_fim:
type: boolean
title: Completion Fim
default: false
fine_tuning:
type: boolean
title: Fine Tuning
default: false
vision:
type: boolean
title: Vision
default: false
ocr:
type: boolean
title: Ocr
default: false
classification:
type: boolean
title: Classification
default: false
moderation:
type: boolean
title: Moderation
default: false
audio:
type: boolean
title: Audio
default: false
audio_transcription:
type: boolean
title: Audio Transcription
default: false
type: object
title: ModelCapabilities
ModelList:
properties:
object:
type: string
title: Object
default: list
data:
items:
oneOf:
- $ref: '#/components/schemas/BaseModelCard'
- $ref: '#/components/schemas/FTModelCard'
discriminator:
propertyName: type
mapping:
base: '#/components/schemas/BaseModelCard'
fine-tuned: '#/components/schemas/FTModelCard'
type: array
title: Data
type: object
title: ModelList
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
APIKeyAuth:
type: object
properties:
type:
type: string
title: Type
enum:
- api-key
default: api-key
value:
type: string
title: Value
title: APIKeyAuth
required:
- value
additionalProperties: false
Agent:
type: object
properties:
instructions:
anyOf:
- type: string
- type: 'null'
title: Instructions
description: Instruction prompt the model will follow during the conversation.
tools:
type: array
items:
oneOf:
- $ref: '#/components/schemas/FunctionTool'
- $ref: '#/components/schemas/WebSearchTool'
- $ref: '#/components/schemas/WebSearchPremiumTool'
- $ref: '#/components/schemas/CodeInterpreterTool'
- $ref: '#/components/schemas/ImageGenerationTool'
- $ref: '#/components/schemas/DocumentLibraryTool'
- $ref: '#/components/schemas/CustomConnector'
discriminator:
propertyName: type
mapping:
code_interpreter: '#/components/schemas/CodeInterpreterTool'
connector: '#/components/schemas/CustomConnector'
document_library: '#/components/schemas/DocumentLibraryTool'
function: '#/components/schemas/FunctionTool'
image_generation: '#/components/schemas/ImageGenerationTool'
web_search: '#/components/schemas/WebSearchTool'
web_search_premium: '#/components/schemas/WebSearchPremiumTool'
title: Tools
description: List of tools which are available to the model during the conversation.
completion_args:
$ref: '#/components/schemas/CompletionArgs'
description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request.
guardrails:
anyOf:
- type: array
items:
$ref: '#/components/schemas/GuardrailConfig'
- type: 'null'
title: Guardrails
model:
type: string
title: Model
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
handoffs:
anyOf:
- type: array
items:
type: string
minItems: 1
- type: 'null'
title: Handoffs
metadata:
anyOf:
- $ref: '#/components/schemas/MetadataDict'
- type: 'null'
object:
type: string
title: Object
default: agent
const: agent
id:
type: string
title: Id
version:
type: integer
title: Version
versions:
type: array
items:
type: integer
title: Versions
created_at:
type: string
title: Created At
format: date-time
updated_at:
type: string
title: Updated At
format: date-time
deployment_chat:
type: boolean
title: Deployment Chat
source:
type: string
title: Source
version_message:
anyOf:
- type: string
- type: 'null'
title: Version Message
title: Agent
required:
- model
- name
- id
- version
- versions
- created_at
- updated_at
- deployment_chat
- source
additionalProperties: false
AgentAliasResponse:
type: object
properties:
alias:
type: string
title: Alias
version:
type: integer
title: Version
created_at:
type: string
title: Created At
format: date-time
updated_at:
type: string
title: Updated At
format: date-time
title: AgentAliasResponse
required:
- alias
- version
- created_at
- updated_at
additionalProperties: false
AgentConversation:
type: object
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: Name given to the conversation.
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Description of the what the conversation is about.
metadata:
anyOf:
- $ref: '#/components/schemas/MetadataDict'
- type: 'null'
description: Custom metadata for the conversation.
object:
type: string
title: Object
default: conversation
const: conversation
id:
type: string
title: Id
created_at:
type: string
title: Created At
format: date-time
updated_at:
type: string
title: Updated At
format: date-time
agent_id:
type: string
title: Agent Id
agent_version:
anyOf:
- type: string
- type: integer
- type: 'null'
title: Agent Version
title: AgentConversation
required:
- id
- created_at
- updated_at
- agent_id
additionalProperties: false
AgentCreationRequest:
type: object
properties:
instructions:
anyOf:
- type: string
- type: 'null'
title: Instructions
description: Instruction prompt the model will follow during the conversation.
tools:
type: array
items:
oneOf:
- $ref: '#/components/schemas/FunctionTool'
- $ref: '#/components/schemas/WebSearchTool'
- $ref: '#/components/schemas/WebSearchPremiumTool'
- $ref: '#/components/schemas/CodeInterpreterTool'
- $ref: '#/components/schemas/ImageGenerationTool'
- $ref: '#/components/schemas/DocumentLibraryTool'
- $ref: '#/components/schemas/CustomConnector'
discriminator:
propertyName: type
mapping:
code_interpreter: '#/components/schemas/CodeInterpreterTool'
connector: '#/components/schemas/CustomConnector'
document_library: '#/components/schemas/DocumentLibraryTool'
function: '#/components/schemas/FunctionTool'
image_generation: '#/components/schemas/ImageGenerationTool'
web_search: '#/components/schemas/WebSearchTool'
web_search_premium: '#/components/schemas/WebSearchPremiumTool'
title: Tools
description: List of tools which are available to the model during the conversation.
completion_args:
$ref: '#/components/schemas/CompletionArgs'
description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request.
guardrails:
anyOf:
- type: array
items:
$ref: '#/components/schemas/GuardrailConfig'
- type: 'null'
title: Guardrails
model:
type: string
title: Model
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
handoffs:
anyOf:
- type: array
items:
type: string
minItems: 1
- type: 'null'
title: Handoffs
metadata:
anyOf:
- $ref: '#/components/schemas/MetadataDict'
- type: 'null'
version_message:
anyOf:
- type: string
maxLength: 500
- type: 'null'
title: Version Message
title: AgentCreationRequest
required:
- model
- name
additionalProperties: false
AgentHandoffEntry:
type: object
properties:
object:
type: string
title: Object
default: entry
const: entry
type:
type: string
title: Type
default: agent.handoff
const: agent.handoff
created_at:
type: string
title: Created At
format: date-time
completed_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Completed At
id:
type: string
title: Id
previous_agent_id:
type: string
title: Previous Agent Id
previous_agent_name:
type: string
title: Previous Agent Name
next_agent_id:
type: string
title: Next Agent Id
next_agent_name:
type: string
title: Next Agent Name
title: AgentHandoffEntry
required:
- previous_agent_id
- previous_agent_name
- next_agent_id
- next_agent_name
additionalProperties: false
AgentUpdateRequest:
type: object
properties:
instructions:
anyOf:
- type: string
- type: 'null'
title: Instructions
description: Instruction prompt the model will follow during the conversation.
tools:
type: array
items:
oneOf:
- $ref: '#/components/schemas/FunctionTool'
- $ref: '#/components/schemas/WebSearchTool'
- $ref: '#/components/schemas/WebSearchPremiumTool'
- $ref: '#/components/schemas/CodeInterpreterTool'
- $ref: '#/components/schemas/ImageGenerationTool'
- $ref: '#/components/schemas/DocumentLibraryTool'
- $ref: '#/components/schemas/CustomConnector'
discriminator:
propertyName: type
mapping:
code_interpreter: '#/components/schemas/CodeInterpreterTool'
connector: '#/components/schemas/CustomConnector'
document_library: '#/components/schemas/DocumentLibraryTool'
function: '#/components/schemas/FunctionTool'
image_generation: '#/components/schemas/ImageGenerationTool'
web_search: '#/components/schemas/WebSearchTool'
web_search_premium: '#/components/schemas/WebSearchPremiumTool'
title: Tools
description: List of tools which are available to the model during the conversation.
completion_args:
$ref: '#/components/schemas/CompletionArgs'
description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request.
guardrails:
anyOf:
- type: array
items:
$ref: '#/components/schemas/GuardrailConfig'
- type: 'null'
title: Guardrails
model:
anyOf:
- type: string
- type: 'null'
title: Model
name:
anyOf:
- type: string
- type: 'null'
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
handoffs:
anyOf:
- type: array
items:
type: string
minItems: 1
- type: 'null'
title: Handoffs
deployment_chat:
anyOf:
- type: boolean
- type: 'null'
title: Deployment Chat
metadata:
anyOf:
- $ref: '#/components/schemas/MetadataDict'
- type: 'null'
version_message:
anyOf:
- type: string
maxLength: 500
- type: 'null'
title: Version Message
title: AgentUpdateRequest
additionalProperties: false
BuiltInConnectors:
type: string
title: BuiltInConnectors
enum:
- web_search
- web_search_premium
- code_interpreter
- image_generation
- document_library
CodeInterpreterTool:
type: object
properties:
tool_configuration:
anyOf:
- $ref: '#/components/schemas/ToolConfiguration'
- type: 'null'
type:
type: string
title: Type
enum:
- code_interpreter
default: code_interpreter
title: CodeInterpreterTool
additionalProperties: false
CompletionArgs:
type: object
properties:
stop:
$ref: '#/components/schemas/CompletionArgsStop'
presence_penalty:
anyOf:
- type: number
maximum: 2
minimum: -2
- type: 'null'
title: Presence Penalty
frequency_penalty:
anyOf:
- type: number
maximum: 2
minimum: -2
- type: 'null'
title: Frequency Penalty
temperature:
anyOf:
- type: number
maximum: 1
minimum: 0
- type: 'null'
title: Temperature
top_p:
anyOf:
- type: number
maximum: 1
minimum: 0
- type: 'null'
title: Top P
max_tokens:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Max Tokens
random_seed:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Random Seed
prediction:
anyOf:
- $ref: '#/components/schemas/Prediction'
- type: 'null'
response_format:
anyOf:
- $ref: '#/components/schemas/ResponseFormat'
- type: 'null'
tool_choice:
$ref: '#/components/schemas/ToolChoiceEnum'
default: auto
reasoning_effort:
anyOf:
- type: string
enum:
- high
- none
- type: 'null'
description: Controls the reasoning effort level for reasoning models. "high" enables comprehensive reasoning traces, "none" disables reasoning effort.
title: CompletionArgs
additionalProperties: false
description: White-listed arguments from the completion API
ConversationAppendRequest:
allOf:
- $ref: '#/components/schemas/ConversationAppendRequestBase'
- type: object
properties:
stream:
type: boolean
enum:
- false
default: false
ConversationHistory:
type: object
properties:
object:
type: string
title: Object
default: conversation.history
const: conversation.history
conversation_id:
type: string
title: Conversation Id
entries:
type: array
items:
anyOf:
- $ref: '#/components/schemas/MessageInputEntry'
- $ref: '#/components/schemas/MessageOutputEntry'
- $ref: '#/components/schemas/FunctionResultEntry'
- $ref: '#/components/schemas/FunctionCallEntry'
- $ref: '#/components/schemas/ToolExecutionEntry'
- $ref: '#/components/schemas/AgentHandoffEntry'
title: Entries
title: ConversationHistory
required:
- conversation_id
- entries
additionalProperties: false
description: Retrieve all entries in a conversation.
ConversationMessages:
type: object
properties:
object:
type: string
title: Object
default: conversation.messages
const: conversation.messages
conversation_id:
type: string
title: Conversation Id
messages:
$ref: '#/components/schemas/MessageEntries'
title: ConversationMessages
required:
- conversation_id
- messages
additionalProperties: false
description: Similar to the conversation history but only keep the messages
ConversationRestartRequest:
allOf:
- $ref: '#/components/schemas/ConversationRestartRequestBase'
- type: object
properties:
stream:
type: boolean
enum:
- false
default: false
CustomConnector:
type: object
properties:
type:
type: string
title: Type
enum:
- connector
default: connector
connector_id:
type: string
title: Connector Id
authorization:
anyOf:
- oneOf:
- $ref: '#/components/schemas/OAuth2TokenAuth'
- $ref: '#/components/schemas/APIKeyAuth'
discriminator:
propertyName: type
mapping:
api-key: '#/components/schemas/APIKeyAuth'
oauth2-token: '#/components/schemas/OAuth2TokenAuth'
- type: 'null'
title: Authorization
tool_configuration:
anyOf:
- $ref: '#/components/schemas/ToolConfiguration'
- type: 'null'
title: CustomConnector
required:
- connector_id
additionalProperties: false
DocumentLibraryTool:
type: object
properties:
tool_configuration:
anyOf:
- $ref: '#/components/schemas/ToolConfiguration'
- type: 'null'
type:
type: string
title: Type
enum:
- document_library
default: document_library
library_ids:
type: array
items:
type: string
title: Library Ids
minItems: 1
description: Ids of the library in which to search.
title: DocumentLibraryTool
required:
- library_ids
additionalProperties: false
DocumentURLChunk:
type: object
properties:
type:
type: string
title: Type
default: document_url
const: document_url
document_url:
type: string
title: Document Url
document_name:
anyOf:
- type: string
- type: 'null'
title: Document Name
description: The filename of the document
title: DocumentURLChunk
required:
- document_url
additionalProperties: false
Function:
type: object
properties:
name:
type: string
title: Name
description:
type: string
title: Description
default: ''
strict:
type: boolean
title: Strict
default: false
parameters:
type: object
title: Parameters
additionalProperties: true
title: Function
required:
- name
- parameters
additionalProperties: false
FunctionCallEntry:
type: object
properties:
object:
type: string
title: Object
default: entry
const: entry
type:
type: string
title: Type
default: function.call
const: function.call
created_at:
type: string
title: Created At
format: date-time
completed_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Completed At
agent_id:
anyOf:
- type: string
- type: 'null'
title: Agent Id
model:
anyOf:
- type: string
- type: 'null'
title: Model
id:
type: string
title: Id
tool_call_id:
type: string
title: Tool Call Id
name:
type: string
title: Name
arguments:
$ref: '#/components/schemas/FunctionCallEntryArguments'
confirmation_status:
anyOf:
- type: string
enum:
- pending
- allowed
- denied
- type: 'null'
title: Confirmation Status
title: FunctionCallEntry
required:
- tool_call_id
- name
- arguments
additionalProperties: false
FunctionResultEntry:
type: object
properties:
object:
type: string
title: Object
default: entry
const: entry
type:
type: string
title: Type
default: function.result
const: function.result
created_at:
type: string
title: Created At
format: date-time
completed_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Completed At
id:
type: string
title: Id
tool_call_id:
type: string
title: Tool Call Id
result:
type: string
title: Result
title: FunctionResultEntry
required:
- tool_call_id
- result
additionalProperties: false
FunctionTool:
type: object
properties:
type:
type: string
title: Type
enum:
- function
default: function
function:
$ref: '#/components/schemas/Function'
title: FunctionTool
required:
- function
additionalProperties: false
GuardrailConfig:
type: object
properties:
block_on_error:
type: boolean
title: Block On Error
description: If true, return HTTP 403 and block request in the event of a server-side error
default: false
moderation_llm_v1:
anyOf:
- $ref: '#/components/schemas/ModerationLLMV1Config'
- type: 'null'
moderation_llm_v2:
anyOf:
- $ref: '#/components/schemas/ModerationLLMV2Config'
- type: 'null'
title: GuardrailConfig
ImageDetail:
type: string
title: ImageDetail
enum:
- low
- auto
- high
ImageGenerationTool:
type: object
properties:
tool_configuration:
anyOf:
- $ref: '#/components/schemas/ToolConfiguration'
- type: 'null'
type:
type: string
title: Type
enum:
- image_generation
default: image_generation
title: ImageGenerationTool
additionalProperties: false
ImageURL:
type: object
properties:
url:
type: string
title: Url
detail:
anyOf:
- $ref: '#/components/schemas/ImageDetail'
- type: 'null'
title: ImageURL
required:
- url
additionalProperties: false
ImageURLChunk:
type: object
properties:
type:
type: string
title: Type
default: image_url
const: image_url
image_url:
anyOf:
- $ref: '#/components/schemas/ImageURL'
- type: string
title: Image Url
title: ImageURLChunk
required:
- image_url
additionalProperties: false
description: '{"type":"image_url","image_url":{"url":"data:image/png;base64,iVBORw0'
JsonSchema:
type: object
properties:
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
schema:
type: object
title: Schema
additionalProperties: true
x-speakeasy-name-override: schema_definition
strict:
type: boolean
title: Strict
default: false
title: JsonSchema
required:
- name
- schema
additionalProperties: false
MessageInputEntry:
type: object
properties:
object:
type: string
title: Object
default: entry
const: entry
type:
type: string
title: Type
default: message.input
const: message.input
created_at:
type: string
title: Created At
format: date-time
completed_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Completed At
id:
type: string
title: Id
role:
type: string
title: Role
enum:
- assistant
- user
content:
anyOf:
- type: string
- $ref: '#/components/schemas/MessageInputContentChunks'
title: Content
prefix:
type: boolean
title: Prefix
default: false
title: MessageInputEntry
required:
- role
- content
additionalProperties: false
description: Representation of an input message inside the conversation.
MessageOutputEntry:
type: object
properties:
object:
type: string
title: Object
default: entry
const: entry
type:
type: string
title: Type
default: message.output
const: message.output
created_at:
type: string
title: Created At
format: date-time
completed_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Completed At
agent_id:
anyOf:
- type: string
- type: 'null'
title: Agent Id
model:
anyOf:
- type: string
- type: 'null'
title: Model
id:
type: string
title: Id
role:
type: string
title: Role
default: assistant
const: assistant
content:
anyOf:
- type: string
- $ref: '#/components/schemas/MessageOutputContentChunks'
title: Content
title: MessageOutputEntry
required:
- content
additionalProperties: false
MetadataDict:
type: object
title: MetadataDict
additionalProperties: true
description: Custom type for metadata with embedded validation.
ModelConversation:
type: object
properties:
instructions:
anyOf:
- type: string
- type: 'null'
title: Instructions
description: Instruction prompt the model will follow during the conversation.
tools:
type: array
items:
oneOf:
- $ref: '#/components/schemas/FunctionTool'
- $ref: '#/components/schemas/WebSearchTool'
- $ref: '#/components/schemas/WebSearchPremiumTool'
- $ref: '#/components/schemas/CodeInterpreterTool'
- $ref: '#/components/schemas/ImageGenerationTool'
- $ref: '#/components/schemas/DocumentLibraryTool'
- $ref: '#/components/schemas/CustomConnector'
discriminator:
propertyName: type
mapping:
code_interpreter: '#/components/schemas/CodeInterpreterTool'
connector: '#/components/schemas/CustomConnector'
document_library: '#/components/schemas/DocumentLibraryTool'
function: '#/components/schemas/FunctionTool'
image_generation: '#/components/schemas/ImageGenerationTool'
web_search: '#/components/schemas/WebSearchTool'
web_search_premium: '#/components/schemas/WebSearchPremiumTool'
title: Tools
description: List of tools which are available to the model during the conversation.
completion_args:
$ref: '#/components/schemas/CompletionArgs'
description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request.
guardrails:
anyOf:
- type: array
items:
$ref: '#/components/schemas/GuardrailConfig'
- type: 'null'
title: Guardrails
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: Name given to the conversation.
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Description of the what the conversation is about.
metadata:
anyOf:
- $ref: '#/components/schemas/MetadataDict'
- type: 'null'
description: Custom metadata for the conversation.
object:
type: string
title: Object
default: conversation
const: conversation
id:
type: string
title: Id
created_at:
type: string
title: Created At
format: date-time
updated_at:
type: string
title: Updated At
format: date-time
model:
type: string
title: Model
title: ModelConversation
required:
- id
- created_at
- updated_at
- model
additionalProperties: false
ModerationLLMAction:
type: string
title: ModerationLLMAction
enum:
- none
- block
ModerationLLMV1CategoryThresholds:
type: object
properties:
sexual:
anyOf:
- type: number
- type: 'null'
title: Sexual
hate_and_discrimination:
anyOf:
- type: number
- type: 'null'
title: Hate And Discrimination
violence_and_threats:
anyOf:
- type: number
- type: 'null'
title: Violence And Threats
dangerous_and_criminal_content:
anyOf:
- type: number
- type: 'null'
title: Dangerous And Criminal Content
selfharm:
anyOf:
- type: number
- type: 'null'
title: Selfharm
health:
anyOf:
- type: number
- type: 'null'
title: Health
financial:
anyOf:
- type: number
- type: 'null'
title: Financial
law:
anyOf:
- type: number
- type: 'null'
title: Law
pii:
anyOf:
- type: number
- type: 'null'
title: Pii
title: ModerationLLMV1CategoryThresholds
ModerationLLMV1Config:
type: object
properties:
model_name:
type: string
title: Model Name
description: Override model name. Should be omitted in general.
default: mistral-moderation-2411
custom_category_thresholds:
anyOf:
- $ref: '#/components/schemas/ModerationLLMV1CategoryThresholds'
- type: 'null'
ignore_other_categories:
type: boolean
title: Ignore Other Categories
description: If true, only evaluate categories in custom_category_thresholds; others are ignored.
default: false
action:
$ref: '#/components/schemas/ModerationLLMAction'
description: Action to take if any score is above the threshold for any category.
default: none
title: ModerationLLMV1Config
ModerationLLMV2CategoryThresholds:
type: object
properties:
sexual:
anyOf:
- type: number
- type: 'null'
title: Sexual
hate_and_discrimination:
anyOf:
- type: number
- type: 'null'
title: Hate And Discrimination
violence_and_threats:
anyOf:
- type: number
- type: 'null'
title: Violence And Threats
dangerous:
anyOf:
- type: number
- type: 'null'
title: Dangerous
criminal:
anyOf:
- type: number
- type: 'null'
title: Criminal
selfharm:
anyOf:
- type: number
- type: 'null'
title: Selfharm
health:
anyOf:
- type: number
- type: 'null'
title: Health
financial:
anyOf:
- type: number
- type: 'null'
title: Financial
law:
anyOf:
- type: number
- type: 'null'
title: Law
pii:
anyOf:
- type: number
- type: 'null'
title: Pii
jailbreaking:
anyOf:
- type: number
- type: 'null'
title: Jailbreaking
title: ModerationLLMV2CategoryThresholds
ModerationLLMV2Config:
type: object
properties:
model_name:
type: string
title: Model Name
description: Override model name. Should be omitted in general.
default: mistral-moderation-2603
custom_category_thresholds:
anyOf:
- $ref: '#/components/schemas/ModerationLLMV2CategoryThresholds'
- type: 'null'
ignore_other_categories:
type: boolean
title: Ignore Other Categories
description: If true, only evaluate categories in custom_category_thresholds; others are ignored.
default: false
action:
$ref: '#/components/schemas/ModerationLLMAction'
description: Action to take if any score is above the threshold for any category.
default: none
title: ModerationLLMV2Config
OAuth2TokenAuth:
type: object
properties:
type:
type: string
title: Type
enum:
- oauth2-token
default: oauth2-token
value:
type: string
title: Value
title: OAuth2TokenAuth
required:
- value
additionalProperties: false
Prediction:
type: object
properties:
type:
type: string
title: Type
default: content
const: content
content:
type: string
title: Content
default: ''
title: Prediction
additionalProperties: false
description: Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content.
RequestSource:
type: string
title: RequestSource
enum:
- api
- playground
- agent_builder_v1
ResponseFormat:
type: object
examples:
- type: text
- type: json_object
- type: json_schema
json_schema:
schema:
properties:
name:
title: Name
type: string
authors:
items:
type: string
title: Authors
type: array
required:
- name
- authors
title: Book
type: object
additionalProperties: false
name: book
strict: true
properties:
type:
$ref: '#/components/schemas/ResponseFormats'
default: text
json_schema:
anyOf:
- $ref: '#/components/schemas/JsonSchema'
- type: 'null'
title: ResponseFormat
additionalProperties: false
description: 'Specify the format that the model must output. By default it will use `{ "type": "text" }`. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. Setting to `{ "type": "json_schema" }` enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide.'
ResponseFormats:
type: string
title: ResponseFormats
enum:
- text
- json_object
- json_schema
TextChunk:
type: object
properties:
type:
type: string
title: Type
default: text
const: text
text:
type: string
title: Text
title: TextChunk
required:
- text
additionalProperties: false
ThinkChunk:
type: object
properties:
type:
type: string
title: Type
default: thinking
const: thinking
thinking:
type: array
items:
anyOf:
- $ref: '#/components/schemas/TextChunk'
- $ref: '#/components/schemas/ToolReferenceChunk'
- $ref: '#/components/schemas/ReferenceChunk'
title: Thinking
closed:
type: boolean
title: Closed
description: Whether the thinking chunk is closed or not. Currently only used for prefixing.
default: true
title: ThinkChunk
required:
- thinking
additionalProperties: false
ToolCallConfirmation:
type: object
properties:
tool_call_id:
type: string
title: Tool Call Id
confirmation:
type: string
title: Confirmation
enum:
- allow
- deny
title: ToolCallConfirmation
required:
- tool_call_id
- confirmation
additionalProperties: false
ToolChoiceEnum:
type: string
title: ToolChoiceEnum
enum:
- auto
- none
- any
- required
ToolConfiguration:
type: object
properties:
exclude:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Exclude
include:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Include
requires_confirmation:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Requires Confirmation
title: ToolConfiguration
additionalProperties: false
ToolExecutionEntry:
type: object
properties:
object:
type: string
title: Object
default: entry
const: entry
type:
type: string
title: Type
default: tool.execution
const: tool.execution
created_at:
type: string
title: Created At
format: date-time
completed_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Completed At
agent_id:
anyOf:
- type: string
- type: 'null'
title: Agent Id
model:
anyOf:
- type: string
- type: 'null'
title: Model
id:
type: string
title: Id
name:
anyOf:
- $ref: '#/components/schemas/BuiltInConnectors'
- type: string
title: Name
arguments:
type: string
title: Arguments
info:
$ref: '#/components/schemas/ToolExecutionInfo'
title: ToolExecutionEntry
required:
- name
- arguments
additionalProperties: false
ToolFileChunk:
type: object
properties:
type:
type: string
title: Type
default: tool_file
const: tool_file
tool:
anyOf:
- $ref: '#/components/schemas/BuiltInConnectors'
- type: string
title: Tool
file_id:
type: string
title: File Id
file_name:
anyOf:
- type: string
- type: 'null'
title: File Name
file_type:
anyOf:
- type: string
- type: 'null'
title: File Type
title: ToolFileChunk
required:
- tool
- file_id
additionalProperties: false
ToolReferenceChunk:
type: object
properties:
type:
type: string
title: Type
default: tool_reference
const: tool_reference
tool:
anyOf:
- $ref: '#/components/schemas/BuiltInConnectors'
- type: string
title: Tool
title:
type: string
title: Title
url:
anyOf:
- type: string
- type: 'null'
title: Url
favicon:
anyOf:
- type: string
- type: 'null'
title: Favicon
description:
anyOf:
- type: string
- type: 'null'
title: Description
title: ToolReferenceChunk
required:
- tool
- title
additionalProperties: false
WebSearchPremiumTool:
type: object
properties:
tool_configuration:
anyOf:
- $ref: '#/components/schemas/ToolConfiguration'
- type: 'null'
type:
type: string
title: Type
enum:
- web_search_premium
default: web_search_premium
title: WebSearchPremiumTool
additionalProperties: false
WebSearchTool:
type: object
properties:
tool_configuration:
anyOf:
- $ref: '#/components/schemas/ToolConfiguration'
- type: 'null'
type:
type: string
title: Type
enum:
- web_search
default: web_search
title: WebSearchTool
additionalProperties: false
ConversationUsageInfo:
type: object
properties:
prompt_tokens:
type: integer
title: Prompt Tokens
default: 0
completion_tokens:
type: integer
title: Completion Tokens
default: 0
total_tokens:
type: integer
title: Total Tokens
default: 0
connector_tokens:
anyOf:
- type: integer
- type: 'null'
title: Connector Tokens
default: null
connectors:
anyOf:
- type: object
additionalProperties:
type: integer
- type: 'null'
title: Connectors
default: null
title: ConversationUsageInfo
additionalProperties: false
ConversationResponse:
type: object
properties:
object:
type: string
title: Object
default: conversation.response
const: conversation.response
conversation_id:
type: string
title: Conversation Id
outputs:
type: array
items:
anyOf:
- $ref: '#/components/schemas/MessageOutputEntry'
- $ref: '#/components/schemas/ToolExecutionEntry'
- $ref: '#/components/schemas/FunctionCallEntry'
- $ref: '#/components/schemas/AgentHandoffEntry'
title: Outputs
usage:
$ref: '#/components/schemas/ConversationUsageInfo'
guardrails:
anyOf:
- type: array
items:
type: object
- type: 'null'
title: Guardrails
default: null
title: ConversationResponse
required:
- conversation_id
- outputs
- usage
additionalProperties: false
description: The response after appending new entries to the conversation.
ConversationRequest:
allOf:
- $ref: '#/components/schemas/ConversationRequestBase'
- type: object
properties:
stream:
type: boolean
enum:
- false
default: false
AgentHandoffDoneEvent:
type: object
properties:
type:
type: string
title: Type
default: agent.handoff.done
const: agent.handoff.done
created_at:
type: string
title: Created At
format: date-time
output_index:
type: integer
title: Output Index
default: 0
id:
type: string
title: Id
next_agent_id:
type: string
title: Next Agent Id
next_agent_name:
type: string
title: Next Agent Name
title: AgentHandoffDoneEvent
required:
- id
- next_agent_id
- next_agent_name
additionalProperties: false
AgentHandoffStartedEvent:
type: object
properties:
type:
type: string
title: Type
default: agent.handoff.started
const: agent.handoff.started
created_at:
type: string
title: Created At
format: date-time
output_index:
type: integer
title: Output Index
default: 0
id:
type: string
title: Id
previous_agent_id:
type: string
title: Previous Agent Id
previous_agent_name:
type: string
title: Previous Agent Name
title: AgentHandoffStartedEvent
required:
- id
- previous_agent_id
- previous_agent_name
additionalProperties: false
FunctionCallEvent:
type: object
properties:
type:
type: string
title: Type
default: function.call.delta
const: function.call.delta
created_at:
type: string
title: Created At
format: date-time
output_index:
type: integer
title: Output Index
default: 0
id:
type: string
title: Id
model:
anyOf:
- type: string
- type: 'null'
title: Model
default: null
agent_id:
anyOf:
- type: string
- type: 'null'
title: Agent Id
default: null
name:
type: string
title: Name
tool_call_id:
type: string
title: Tool Call Id
arguments:
type: string
title: Arguments
confirmation_status:
anyOf:
- type: string
enum:
- pending
- allowed
- denied
- type: 'null'
title: Confirmation Status
default: null
title: FunctionCallEvent
required:
- id
- name
- tool_call_id
- arguments
additionalProperties: false
MessageOutputEvent:
type: object
properties:
type:
type: string
title: Type
default: message.output.delta
const: message.output.delta
created_at:
type: string
title: Created At
format: date-time
output_index:
type: integer
title: Output Index
default: 0
id:
type: string
title: Id
content_index:
type: integer
title: Content Index
default: 0
model:
anyOf:
- type: string
- type: 'null'
title: Model
default: null
agent_id:
anyOf:
- type: string
- type: 'null'
title: Agent Id
default: null
role:
type: string
title: Role
default: assistant
const: assistant
content:
anyOf:
- type: string
- $ref: '#/components/schemas/OutputContentChunks'
title: Content
title: MessageOutputEvent
required:
- id
- content
additionalProperties: false
ResponseDoneEvent:
type: object
properties:
type:
type: string
title: Type
default: conversation.response.done
const: conversation.response.done
created_at:
type: string
title: Created At
format: date-time
usage:
$ref: '#/components/schemas/ConversationUsageInfo'
title: ResponseDoneEvent
required:
- usage
additionalProperties: false
ResponseErrorEvent:
type: object
properties:
type:
type: string
title: Type
default: conversation.response.error
const: conversation.response.error
created_at:
type: string
title: Created At
format: date-time
message:
type: string
title: Message
code:
type: integer
title: Code
title: ResponseErrorEvent
required:
- message
- code
additionalProperties: false
ResponseStartedEvent:
type: object
properties:
type:
type: string
title: Type
default: conversation.response.started
const: conversation.response.started
created_at:
type: string
title: Created At
format: date-time
conversation_id:
type: string
title: Conversation Id
title: ResponseStartedEvent
required:
- conversation_id
additionalProperties: false
SSETypes:
type: string
title: SSETypes
enum:
- conversation.response.started
- conversation.response.done
- conversation.response.error
- message.output.delta
- tool.execution.started
- tool.execution.delta
- tool.execution.done
- agent.handoff.started
- agent.handoff.done
- function.call.delta
description: Server side events sent when streaming a conversation response.
ToolExecutionDeltaEvent:
type: object
properties:
type:
type: string
title: Type
default: tool.execution.delta
const: tool.execution.delta
created_at:
type: string
title: Created At
format: date-time
output_index:
type: integer
title: Output Index
default: 0
id:
type: string
title: Id
name:
anyOf:
- $ref: '#/components/schemas/BuiltInConnectors'
- type: string
title: Name
arguments:
type: string
title: Arguments
title: ToolExecutionDeltaEvent
required:
- id
- name
- arguments
additionalProperties: false
ToolExecutionDoneEvent:
type: object
properties:
type:
type: string
title: Type
default: tool.execution.done
const: tool.execution.done
created_at:
type: string
title: Created At
format: date-time
output_index:
type: integer
title: Output Index
default: 0
id:
type: string
title: Id
name:
anyOf:
- $ref: '#/components/schemas/BuiltInConnectors'
- type: string
title: Name
info:
$ref: '#/components/schemas/ToolExecutionInfo'
title: ToolExecutionDoneEvent
required:
- id
- name
additionalProperties: false
ToolExecutionStartedEvent:
type: object
properties:
type:
type: string
title: Type
default: tool.execution.started
const: tool.execution.started
created_at:
type: string
title: Created At
format: date-time
output_index:
type: integer
title: Output Index
default: 0
id:
type: string
title: Id
model:
anyOf:
- type: string
- type: 'null'
title: Model
default: null
agent_id:
anyOf:
- type: string
- type: 'null'
title: Agent Id
default: null
name:
anyOf:
- $ref: '#/components/schemas/BuiltInConnectors'
- type: string
title: Name
arguments:
type: string
title: Arguments
title: ToolExecutionStartedEvent
required:
- id
- name
- arguments
additionalProperties: false
ConversationEvents:
type: object
properties:
event:
$ref: '#/components/schemas/SSETypes'
data:
oneOf:
- $ref: '#/components/schemas/ResponseStartedEvent'
- $ref: '#/components/schemas/ResponseDoneEvent'
- $ref: '#/components/schemas/ResponseErrorEvent'
- $ref: '#/components/schemas/ToolExecutionStartedEvent'
- $ref: '#/components/schemas/ToolExecutionDeltaEvent'
- $ref: '#/components/schemas/ToolExecutionDoneEvent'
- $ref: '#/components/schemas/MessageOutputEvent'
- $ref: '#/components/schemas/FunctionCallEvent'
- $ref: '#/components/schemas/AgentHandoffStartedEvent'
- $ref: '#/components/schemas/AgentHandoffDoneEvent'
discriminator:
propertyName: type
mapping:
agent.handoff.done: '#/components/schemas/AgentHandoffDoneEvent'
agent.handoff.started: '#/components/schemas/AgentHandoffStartedEvent'
conversation.response.done: '#/components/schemas/ResponseDoneEvent'
conversation.response.error: '#/components/schemas/ResponseErrorEvent'
conversation.response.started: '#/components/schemas/ResponseStartedEvent'
function.call.delta: '#/components/schemas/FunctionCallEvent'
message.output.delta: '#/components/schemas/MessageOutputEvent'
tool.execution.delta: '#/components/schemas/ToolExecutionDeltaEvent'
tool.execution.done: '#/components/schemas/ToolExecutionDoneEvent'
tool.execution.started: '#/components/schemas/ToolExecutionStartedEvent'
title: Data
title: ConversationEvents
required:
- event
- data
MessageInputContentChunks:
type: array
items:
anyOf:
- $ref: '#/components/schemas/TextChunk'
- $ref: '#/components/schemas/ImageURLChunk'
- $ref: '#/components/schemas/ToolFileChunk'
- $ref: '#/components/schemas/DocumentURLChunk'
- $ref: '#/components/schemas/ThinkChunk'
title: MessageInputContentChunks
MessageOutputContentChunks:
type: array
items:
anyOf:
- $ref: '#/components/schemas/TextChunk'
- $ref: '#/components/schemas/ImageURLChunk'
- $ref: '#/components/schemas/ToolFileChunk'
- $ref: '#/components/schemas/DocumentURLChunk'
- $ref: '#/components/schemas/ThinkChunk'
- $ref: '#/components/schemas/ToolReferenceChunk'
title: MessageOutputContentChunks
OutputContentChunks:
anyOf:
- $ref: '#/components/schemas/TextChunk'
- $ref: '#/components/schemas/ImageURLChunk'
- $ref: '#/components/schemas/ToolFileChunk'
- $ref: '#/components/schemas/DocumentURLChunk'
- $ref: '#/components/schemas/ThinkChunk'
- $ref: '#/components/schemas/ToolReferenceChunk'
title: OutputContentChunks
MessageEntries:
type: array
items:
anyOf:
- $ref: '#/components/schemas/MessageInputEntry'
- $ref: '#/components/schemas/MessageOutputEntry'
title: MessageEntries
InputEntries:
type: array
items:
anyOf:
- $ref: '#/components/schemas/MessageInputEntry'
- $ref: '#/components/schemas/MessageOutputEntry'
- $ref: '#/components/schemas/FunctionResultEntry'
- $ref: '#/components/schemas/FunctionCallEntry'
- $ref: '#/components/schemas/ToolExecutionEntry'
- $ref: '#/components/schemas/AgentHandoffEntry'
title: InputEntries
CompletionArgsStop:
anyOf:
- type: string
- type: array
items:
type: string
- type: 'null'
title: CompletionArgsStop
FunctionCallEntryArguments:
anyOf:
- type: object
additionalProperties: true
- type: string
title: FunctionCallEntryArguments
ConversationInputs:
anyOf:
- type: string
- $ref: '#/components/schemas/InputEntries'
title: ConversationInputs
ToolExecutionInfo:
type: object
title: ToolExecutionInfo
additionalProperties: true
ConversationRequestBase:
type: object
properties:
inputs:
$ref: '#/components/schemas/ConversationInputs'
stream:
anyOf:
- type: boolean
- type: 'null'
title: Stream
default: null
store:
anyOf:
- type: boolean
- type: 'null'
title: Store
default: null
handoff_execution:
anyOf:
- type: string
enum:
- client
- server
- type: 'null'
title: Handoff Execution
default: null
instructions:
anyOf:
- type: string
- type: 'null'
title: Instructions
default: null
tools:
anyOf:
- type: array
items:
oneOf:
- $ref: '#/components/schemas/FunctionTool'
- $ref: '#/components/schemas/WebSearchTool'
- $ref: '#/components/schemas/WebSearchPremiumTool'
- $ref: '#/components/schemas/CodeInterpreterTool'
- $ref: '#/components/schemas/ImageGenerationTool'
- $ref: '#/components/schemas/DocumentLibraryTool'
- $ref: '#/components/schemas/CustomConnector'
discriminator:
propertyName: type
mapping:
code_interpreter: '#/components/schemas/CodeInterpreterTool'
connector: '#/components/schemas/CustomConnector'
document_library: '#/components/schemas/DocumentLibraryTool'
function: '#/components/schemas/FunctionTool'
image_generation: '#/components/schemas/ImageGenerationTool'
web_search: '#/components/schemas/WebSearchTool'
web_search_premium: '#/components/schemas/WebSearchPremiumTool'
- type: 'null'
title: Tools
default: null
completion_args:
anyOf:
- $ref: '#/components/schemas/CompletionArgs'
- type: 'null'
default: null
guardrails:
anyOf:
- type: array
items:
$ref: '#/components/schemas/GuardrailConfig'
- type: 'null'
title: Guardrails
default: null
name:
anyOf:
- type: string
- type: 'null'
title: Name
default: null
description:
anyOf:
- type: string
- type: 'null'
title: Description
default: null
metadata:
anyOf:
- $ref: '#/components/schemas/MetadataDict'
- type: 'null'
default: null
agent_id:
anyOf:
- type: string
- type: 'null'
title: Agent Id
default: null
agent_version:
anyOf:
- type: string
- type: integer
- type: 'null'
title: Agent Version
default: null
model:
anyOf:
- type: string
- type: 'null'
title: Model
default: null
title: ConversationRequest
required:
- inputs
ConversationStreamRequest:
allOf:
- $ref: '#/components/schemas/ConversationRequestBase'
- type: object
properties:
stream:
type: boolean
enum:
- true
default: true
ConversationAppendRequestBase:
type: object
properties:
inputs:
$ref: '#/components/schemas/ConversationInputs'
stream:
type: boolean
title: Stream
description: Whether to stream back partial progress. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.
default: false
store:
type: boolean
title: Store
description: Whether to store the results into our servers or not.
default: true
handoff_execution:
type: string
title: Handoff Execution
enum:
- client
- server
default: server
completion_args:
$ref: '#/components/schemas/CompletionArgs'
description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request.
tool_confirmations:
anyOf:
- type: array
items:
$ref: '#/components/schemas/ToolCallConfirmation'
- type: 'null'
title: Tool Confirmations
title: ConversationAppendRequest
additionalProperties: false
ConversationAppendStreamRequest:
allOf:
- $ref: '#/components/schemas/ConversationAppendRequestBase'
- type: object
properties:
stream:
type: boolean
enum:
- true
default: true
ConversationRestartRequestBase:
type: object
properties:
inputs:
$ref: '#/components/schemas/ConversationInputs'
stream:
type: boolean
title: Stream
description: Whether to stream back partial progress. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.
default: false
store:
type: boolean
title: Store
description: Whether to store the results into our servers or not.
default: true
handoff_execution:
type: string
title: Handoff Execution
enum:
- client
- server
default: server
completion_args:
$ref: '#/components/schemas/CompletionArgs'
description: Completion arguments that will be used to generate assistant responses. Can be overridden at each message request.
guardrails:
anyOf:
- type: array
items:
$ref: '#/components/schemas/GuardrailConfig'
- type: 'null'
title: Guardrails
metadata:
anyOf:
- $ref: '#/components/schemas/MetadataDict'
- type: 'null'
description: Custom metadata for the conversation.
from_entry_id:
type: string
title: From Entry Id
agent_version:
anyOf:
- type: string
- type: integer
- type: 'null'
title: Agent Version
description: Specific version of the agent to use when restarting. If not provided, uses the current version.
title: ConversationRestartRequest
required:
- from_entry_id
additionalProperties: false
description: Request to restart a new conversation from a given entry in the conversation.
ConversationRestartStreamRequest:
allOf:
- $ref: '#/components/schemas/ConversationRestartRequestBase'
- type: object
properties:
stream:
type: boolean
enum:
- true
default: true
ReferenceChunk:
type: object
properties:
type:
type: string
title: Type
default: reference
const: reference
reference_ids:
type: array
items:
type: integer
title: Reference Ids
title: ReferenceChunk
required:
- reference_ids
additionalProperties: false
FilePurpose:
type: string
title: FilePurpose
enum:
- fine-tune
- batch
- ocr
FileVisibility:
type: string
title: FileVisibility
enum:
- workspace
- user
SampleType:
type: string
title: SampleType
enum:
- pretrain
- instruct
- batch_request
- batch_result
- batch_error
Source:
type: string
title: Source
enum:
- upload
- repository
- mistral
UploadFileOut:
type: object
properties:
id:
type: string
examples:
- 497f6eca-6276-4993-bfeb-53cbbbba6f09
title: Id
format: uuid
description: The unique identifier of the file.
object:
type: string
examples:
- file
title: Object
description: The object type, which is always "file".
bytes:
type: integer
examples:
- 13000
title: Bytes
description: The size of the file, in bytes.
created_at:
type: integer
examples:
- 1716963433
title: Created At
description: The UNIX timestamp (in seconds) of the event.
filename:
type: string
examples:
- files_upload.jsonl
title: Filename
description: The name of the uploaded file.
purpose:
$ref: '#/components/schemas/FilePurpose'
examples:
- fine-tune
- ocr
- batch
- audio
description: The intended purpose of the uploaded file, currently supports fine-tuning (`fine-tune`), OCR (`ocr`), Audio/Transcription (`audio`) and batch inference (`batch`).
sample_type:
$ref: '#/components/schemas/SampleType'
num_lines:
anyOf:
- type: integer
- type: 'null'
title: Num Lines
mimetype:
anyOf:
- type: string
- type: 'null'
title: Mimetype
source:
$ref: '#/components/schemas/Source'
signature:
anyOf:
- type: string
- type: 'null'
title: Signature
expires_at:
anyOf:
- type: integer
- type: 'null'
title: Expires At
visibility:
anyOf:
- $ref: '#/components/schemas/FileVisibility'
- type: 'null'
title: UploadFileOut
required:
- id
- object
- bytes
- created_at
- filename
- purpose
- sample_type
- source
FileSchema:
type: object
properties:
id:
type: string
examples:
- 497f6eca-6276-4993-bfeb-53cbbbba6f09
title: Id
format: uuid
description: The unique identifier of the file.
object:
type: string
examples:
- file
title: Object
description: The object type, which is always "file".
bytes:
type: integer
examples:
- 13000
title: Bytes
description: The size of the file, in bytes.
created_at:
type: integer
examples:
- 1716963433
title: Created At
description: The UNIX timestamp (in seconds) of the event.
filename:
type: string
examples:
- files_upload.jsonl
title: Filename
description: The name of the uploaded file.
purpose:
$ref: '#/components/schemas/FilePurpose'
examples:
- fine-tune
- ocr
- batch
- audio
description: The intended purpose of the uploaded file, currently supports fine-tuning (`fine-tune`), OCR (`ocr`), Audio/Transcription (`audio`) and batch inference (`batch`).
sample_type:
$ref: '#/components/schemas/SampleType'
num_lines:
anyOf:
- type: integer
- type: 'null'
title: Num Lines
mimetype:
anyOf:
- type: string
- type: 'null'
title: Mimetype
source:
$ref: '#/components/schemas/Source'
signature:
anyOf:
- type: string
- type: 'null'
title: Signature
expires_at:
anyOf:
- type: integer
- type: 'null'
title: Expires At
visibility:
anyOf:
- $ref: '#/components/schemas/FileVisibility'
- type: 'null'
title: FileSchema
required:
- id
- object
- bytes
- created_at
- filename
- purpose
- sample_type
- source
ListFilesOut:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/FileSchema'
title: Data
object:
type: string
title: Object
total:
anyOf:
- type: integer
- type: 'null'
title: Total
title: ListFilesOut
required:
- data
- object
RetrieveFileOut:
type: object
properties:
id:
type: string
examples:
- 497f6eca-6276-4993-bfeb-53cbbbba6f09
title: Id
format: uuid
description: The unique identifier of the file.
object:
type: string
examples:
- file
title: Object
description: The object type, which is always "file".
bytes:
type: integer
examples:
- 13000
title: Bytes
description: The size of the file, in bytes.
created_at:
type: integer
examples:
- 1716963433
title: Created At
description: The UNIX timestamp (in seconds) of the event.
filename:
type: string
examples:
- files_upload.jsonl
title: Filename
description: The name of the uploaded file.
purpose:
$ref: '#/components/schemas/FilePurpose'
examples:
- fine-tune
- ocr
- batch
- audio
description: The intended purpose of the uploaded file, currently supports fine-tuning (`fine-tune`), OCR (`ocr`), Audio/Transcription (`audio`) and batch inference (`batch`).
sample_type:
$ref: '#/components/schemas/SampleType'
num_lines:
anyOf:
- type: integer
- type: 'null'
title: Num Lines
mimetype:
anyOf:
- type: string
- type: 'null'
title: Mimetype
source:
$ref: '#/components/schemas/Source'
signature:
anyOf:
- type: string
- type: 'null'
title: Signature
expires_at:
anyOf:
- type: integer
- type: 'null'
title: Expires At
visibility:
anyOf:
- $ref: '#/components/schemas/FileVisibility'
- type: 'null'
deleted:
type: boolean
title: Deleted
title: RetrieveFileOut
required:
- id
- object
- bytes
- created_at
- filename
- purpose
- sample_type
- source
- deleted
DeleteFileOut:
type: object
properties:
id:
type: string
examples:
- 497f6eca-6276-4993-bfeb-53cbbbba6f09
title: Id
format: uuid
description: The ID of the deleted file.
object:
type: string
examples:
- file
title: Object
description: The object type that was deleted
deleted:
type: boolean
examples:
- false
title: Deleted
description: The deletion status.
title: DeleteFileOut
required:
- id
- object
- deleted
FileSignedURL:
type: object
properties:
url:
type: string
title: Url
title: FileSignedURL
required:
- url
FineTuneableModelType:
type: string
title: FineTuneableModelType
enum:
- completion
- classifier
ClassifierJobOut:
type: object
properties:
id:
type: string
title: Id
format: uuid
description: The ID of the job.
auto_start:
type: boolean
title: Auto Start
model:
type: string
title: Model
status:
type: string
title: Status
enum:
- QUEUED
- STARTED
- VALIDATING
- VALIDATED
- RUNNING
- FAILED_VALIDATION
- FAILED
- SUCCESS
- CANCELLED
- CANCELLATION_REQUESTED
description: The current status of the fine-tuning job.
created_at:
type: integer
title: Created At
description: The UNIX timestamp (in seconds) for when the fine-tuning job was created.
modified_at:
type: integer
title: Modified At
description: The UNIX timestamp (in seconds) for when the fine-tuning job was last modified.
training_files:
type: array
items:
type: string
format: uuid
title: Training Files
description: A list containing the IDs of uploaded files that contain training data.
validation_files:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Validation Files
description: A list containing the IDs of uploaded files that contain validation data.
default: []
object:
type: string
title: Object
description: The object type of the fine-tuning job.
default: job
const: job
fine_tuned_model:
anyOf:
- type: string
- type: 'null'
title: Fine Tuned Model
description: The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running.
suffix:
anyOf:
- type: string
- type: 'null'
title: Suffix
description: Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`.
integrations:
anyOf:
- type: array
items:
oneOf:
- $ref: '#/components/schemas/WandbIntegrationOut'
discriminator:
propertyName: type
mapping:
wandb: '#/components/schemas/WandbIntegrationOut'
- type: 'null'
title: Integrations
description: A list of integrations enabled for your fine-tuning job.
trained_tokens:
anyOf:
- type: integer
- type: 'null'
title: Trained Tokens
description: Total number of tokens trained.
metadata:
anyOf:
- $ref: '#/components/schemas/JobMetadataOut'
- type: 'null'
job_type:
type: string
title: Job Type
description: The type of job (`FT` for fine-tuning).
default: classifier
const: classifier
hyperparameters:
$ref: '#/components/schemas/ClassifierTrainingParameters'
title: ClassifierJobOut
required:
- id
- auto_start
- model
- status
- created_at
- modified_at
- training_files
- hyperparameters
ClassifierTrainingParameters:
type: object
properties:
training_steps:
anyOf:
- type: integer
minimum: 1
- type: 'null'
title: Training Steps
learning_rate:
type: number
title: Learning Rate
maximum: 1
minimum: 1e-08
default: 0.0001
weight_decay:
anyOf:
- type: number
maximum: 1
minimum: 0
- type: 'null'
title: Weight Decay
default: 0.1
warmup_fraction:
anyOf:
- type: number
maximum: 1
minimum: 0
- type: 'null'
title: Warmup Fraction
default: 0.05
epochs:
anyOf:
- exclusiveMinimum: 0
type: number
- type: 'null'
title: Epochs
seq_len:
anyOf:
- type: integer
minimum: 100
- type: 'null'
title: Seq Len
title: ClassifierTrainingParameters
CompletionJobOut:
type: object
properties:
id:
type: string
title: Id
format: uuid
description: The ID of the job.
auto_start:
type: boolean
title: Auto Start
model:
type: string
title: Model
status:
type: string
title: Status
enum:
- QUEUED
- STARTED
- VALIDATING
- VALIDATED
- RUNNING
- FAILED_VALIDATION
- FAILED
- SUCCESS
- CANCELLED
- CANCELLATION_REQUESTED
description: The current status of the fine-tuning job.
created_at:
type: integer
title: Created At
description: The UNIX timestamp (in seconds) for when the fine-tuning job was created.
modified_at:
type: integer
title: Modified At
description: The UNIX timestamp (in seconds) for when the fine-tuning job was last modified.
training_files:
type: array
items:
type: string
format: uuid
title: Training Files
description: A list containing the IDs of uploaded files that contain training data.
validation_files:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Validation Files
description: A list containing the IDs of uploaded files that contain validation data.
default: []
object:
type: string
title: Object
description: The object type of the fine-tuning job.
default: job
const: job
fine_tuned_model:
anyOf:
- type: string
- type: 'null'
title: Fine Tuned Model
description: The name of the fine-tuned model that is being created. The value will be `null` if the fine-tuning job is still running.
suffix:
anyOf:
- type: string
- type: 'null'
title: Suffix
description: Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`.
integrations:
anyOf:
- type: array
items:
oneOf:
- $ref: '#/components/schemas/WandbIntegrationOut'
discriminator:
propertyName: type
mapping:
wandb: '#/components/schemas/WandbIntegrationOut'
- type: 'null'
title: Integrations
description: A list of integrations enabled for your fine-tuning job.
trained_tokens:
anyOf:
- type: integer
- type: 'null'
title: Trained Tokens
description: Total number of tokens trained.
metadata:
anyOf:
- $ref: '#/components/schemas/JobMetadataOut'
- type: 'null'
job_type:
type: string
title: Job Type
description: The type of job (`FT` for fine-tuning).
default: completion
const: completion
hyperparameters:
$ref: '#/components/schemas/CompletionTrainingParameters'
repositories:
type: array
items:
oneOf:
- $ref: '#/components/schemas/GithubRepositoryOut'
discriminator:
propertyName: type
mapping:
github: '#/components/schemas/GithubRepositoryOut'
title: Repositories
default: []
title: CompletionJobOut
required:
- id
- auto_start
- model
- status
- created_at
- modified_at
- training_files
- hyperparameters
CompletionTrainingParameters:
type: object
properties:
training_steps:
anyOf:
- type: integer
minimum: 1
- type: 'null'
title: Training Steps
learning_rate:
type: number
title: Learning Rate
maximum: 1
minimum: 1e-08
default: 0.0001
weight_decay:
anyOf:
- type: number
maximum: 1
minimum: 0
- type: 'null'
title: Weight Decay
default: 0.1
warmup_fraction:
anyOf:
- type: number
maximum: 1
minimum: 0
- type: 'null'
title: Warmup Fraction
default: 0.05
epochs:
anyOf:
- exclusiveMinimum: 0
type: number
- type: 'null'
title: Epochs
seq_len:
anyOf:
- type: integer
minimum: 100
- type: 'null'
title: Seq Len
fim_ratio:
anyOf:
- type: number
maximum: 1
minimum: 0
- type: 'null'
title: Fim Ratio
default: 0.9
title: CompletionTrainingParameters
GithubRepositoryOut:
type: object
properties:
type:
type: string
title: Type
default: github
const: github
name:
type: string
title: Name
owner:
type: string
title: Owner
ref:
anyOf:
- type: string
- type: 'null'
title: Ref
weight:
exclusiveMinimum: 0
type: number
title: Weight
default: 1.0
commit_id:
type: string
title: Commit Id
maxLength: 40
minLength: 40
title: GithubRepositoryOut
required:
- name
- owner
- commit_id
JobMetadataOut:
type: object
properties:
expected_duration_seconds:
anyOf:
- type: integer
- type: 'null'
title: Expected Duration Seconds
cost:
anyOf:
- type: number
- type: 'null'
title: Cost
cost_currency:
anyOf:
- type: string
- type: 'null'
title: Cost Currency
train_tokens_per_step:
anyOf:
- type: integer
- type: 'null'
title: Train Tokens Per Step
train_tokens:
anyOf:
- type: integer
- type: 'null'
title: Train Tokens
data_tokens:
anyOf:
- type: integer
- type: 'null'
title: Data Tokens
estimated_start_time:
anyOf:
- type: integer
- type: 'null'
title: Estimated Start Time
title: JobMetadataOut
JobsOut:
type: object
properties:
data:
type: array
items:
oneOf:
- $ref: '#/components/schemas/CompletionJobOut'
- $ref: '#/components/schemas/ClassifierJobOut'
discriminator:
propertyName: job_type
mapping:
classifier: '#/components/schemas/ClassifierJobOut'
completion: '#/components/schemas/CompletionJobOut'
title: Data
default: []
object:
type: string
title: Object
default: list
const: list
total:
type: integer
title: Total
title: JobsOut
required:
- total
WandbIntegrationOut:
type: object
properties:
type:
type: string
title: Type
default: wandb
const: wandb
project:
type: string
title: Project
description: The name of the project that the new run will be created under.
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: A display name to set for the run. If not set, will use the job ID as the name.
run_name:
anyOf:
- type: string
- type: 'null'
title: Run Name
url:
anyOf:
- type: string
- type: 'null'
title: Url
title: WandbIntegrationOut
required:
- project
LegacyJobMetadataOut:
type: object
properties:
expected_duration_seconds:
anyOf:
- type: integer
- type: 'null'
examples:
- 220
title: Expected Duration Seconds
description: The approximated time (in seconds) for the fine-tuning process to complete.
cost:
anyOf:
- type: number
- type: 'null'
examples:
- 10
title: Cost
description: The cost of the fine-tuning job.
cost_currency:
anyOf:
- type: string
- type: 'null'
examples:
- EUR
title: Cost Currency
description: The currency used for the fine-tuning job cost.
train_tokens_per_step:
anyOf:
- type: integer
- type: 'null'
examples:
- 131072
title: Train Tokens Per Step
description: The number of tokens consumed by one training step.
train_tokens:
anyOf:
- type: integer
- type: 'null'
examples:
- 1310720
title: Train Tokens
description: The total number of tokens used during the fine-tuning process.
data_tokens:
anyOf:
- type: integer
- type: 'null'
examples:
- 305375
title: Data Tokens
description: The total number of tokens in the training dataset.
estimated_start_time:
anyOf:
- type: integer
- type: 'null'
title: Estimated Start Time
deprecated:
type: boolean
title: Deprecated
default: true
details:
type: string
title: Details
epochs:
anyOf:
- type: number
- type: 'null'
examples:
- 4.2922
title: Epochs
description: The number of complete passes through the entire training dataset.
training_steps:
anyOf:
- type: integer
- type: 'null'
examples:
- 10
title: Training Steps
description: The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset.
object:
type: string
title: Object
default: job.metadata
const: job.metadata
title: LegacyJobMetadataOut
required:
- details
ClassifierTargetIn:
type: object
properties:
name:
type: string
title: Name
labels:
type: array
items:
type: string
title: Labels
weight:
type: number
title: Weight
minimum: 0
default: 1.0
loss_function:
anyOf:
- $ref: '#/components/schemas/FTClassifierLossFunction'
- type: 'null'
title: ClassifierTargetIn
required:
- name
- labels
ClassifierTrainingParametersIn:
type: object
properties:
training_steps:
anyOf:
- type: integer
minimum: 1
- type: 'null'
title: Training Steps
description: The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset.
learning_rate:
type: number
title: Learning Rate
maximum: 1
minimum: 1e-08
description: A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process.
default: 0.0001
weight_decay:
anyOf:
- type: number
maximum: 1
minimum: 0
- type: 'null'
title: Weight Decay
description: (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large.
default: 0.1
warmup_fraction:
anyOf:
- type: number
maximum: 1
minimum: 0
- type: 'null'
title: Warmup Fraction
description: (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune)
default: 0.05
epochs:
anyOf:
- exclusiveMinimum: 0
type: number
- type: 'null'
title: Epochs
seq_len:
anyOf:
- type: integer
minimum: 100
- type: 'null'
title: Seq Len
title: ClassifierTrainingParametersIn
description: The fine-tuning hyperparameter settings used in a classifier fine-tune job.
CompletionTrainingParametersIn:
type: object
properties:
training_steps:
anyOf:
- type: integer
minimum: 1
- type: 'null'
title: Training Steps
description: The number of training steps to perform. A training step refers to a single update of the model weights during the fine-tuning process. This update is typically calculated using a batch of samples from the training dataset.
learning_rate:
type: number
title: Learning Rate
maximum: 1
minimum: 1e-08
description: A parameter describing how much to adjust the pre-trained model's weights in response to the estimated error each time the weights are updated during the fine-tuning process.
default: 0.0001
weight_decay:
anyOf:
- type: number
maximum: 1
minimum: 0
- type: 'null'
title: Weight Decay
description: (Advanced Usage) Weight decay adds a term to the loss function that is proportional to the sum of the squared weights. This term reduces the magnitude of the weights and prevents them from growing too large.
default: 0.1
warmup_fraction:
anyOf:
- type: number
maximum: 1
minimum: 0
- type: 'null'
title: Warmup Fraction
description: (Advanced Usage) A parameter that specifies the percentage of the total training steps at which the learning rate warm-up phase ends. During this phase, the learning rate gradually increases from a small value to the initial learning rate, helping to stabilize the training process and improve convergence. Similar to `pct_start` in [mistral-finetune](https://github.com/mistralai/mistral-finetune)
default: 0.05
epochs:
anyOf:
- exclusiveMinimum: 0
type: number
- type: 'null'
title: Epochs
seq_len:
anyOf:
- type: integer
minimum: 100
- type: 'null'
title: Seq Len
fim_ratio:
anyOf:
- type: number
maximum: 1
minimum: 0
- type: 'null'
title: Fim Ratio
default: 0.9
title: CompletionTrainingParametersIn
description: The fine-tuning hyperparameter settings used in a fine-tune job.
FTClassifierLossFunction:
type: string
title: FTClassifierLossFunction
enum:
- single_class
- multi_class
GithubRepositoryIn:
type: object
properties:
type:
type: string
title: Type
default: github
const: github
name:
type: string
title: Name
owner:
type: string
title: Owner
ref:
anyOf:
- type: string
- type: 'null'
title: Ref
weight:
exclusiveMinimum: 0
type: number
title: Weight
default: 1.0
token:
type: string
title: Token
title: GithubRepositoryIn
required:
- name
- owner
- token
JobIn:
type: object
properties:
model:
type: string
title: Model
training_files:
type: array
items:
$ref: '#/components/schemas/TrainingFile'
title: Training Files
default: []
validation_files:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Validation Files
description: A list containing the IDs of uploaded files that contain validation data. If you provide these files, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in `checkpoints` when getting the status of a running fine-tuning job. The same data should not be present in both train and validation files.
suffix:
anyOf:
- type: string
maxLength: 18
- type: 'null'
title: Suffix
description: A string that will be added to your fine-tuning model name. For example, a suffix of "my-great-model" would produce a model name like `ft:open-mistral-7b:my-great-model:xxx...`
integrations:
anyOf:
- type: array
items:
oneOf:
- $ref: '#/components/schemas/WandbIntegration'
discriminator:
propertyName: type
mapping:
wandb: '#/components/schemas/WandbIntegration'
- type: 'null'
title: Integrations
description: A list of integrations to enable for your fine-tuning job.
auto_start:
type: boolean
title: Auto Start
description: This field will be required in a future release.
invalid_sample_skip_percentage:
type: number
title: Invalid Sample Skip Percentage
maximum: 0.5
minimum: 0
default: 0
job_type:
anyOf:
- $ref: '#/components/schemas/FineTuneableModelType'
- type: 'null'
hyperparameters:
anyOf:
- $ref: '#/components/schemas/CompletionTrainingParametersIn'
- $ref: '#/components/schemas/ClassifierTrainingParametersIn'
title: Hyperparameters
repositories:
anyOf:
- type: array
items:
oneOf:
- $ref: '#/components/schemas/GithubRepositoryIn'
discriminator:
propertyName: type
mapping:
github: '#/components/schemas/GithubRepositoryIn'
- type: 'null'
title: Repositories
classifier_targets:
anyOf:
- type: array
items:
$ref: '#/components/schemas/ClassifierTargetIn'
- type: 'null'
title: Classifier Targets
title: JobIn
required:
- model
- hyperparameters
TrainingFile:
type: object
properties:
file_id:
type: string
title: File Id
format: uuid
weight:
exclusiveMinimum: 0
type: number
title: Weight
default: 1.0
title: TrainingFile
required:
- file_id
WandbIntegration:
type: object
properties:
type:
type: string
title: Type
default: wandb
const: wandb
project:
type: string
title: Project
description: The name of the project that the new run will be created under.
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: A display name to set for the run. If not set, will use the job ID as the name.
api_key:
type: string
title: Api Key
maxLength: 40
minLength: 40
description: The WandB API key to use for authentication.
run_name:
anyOf:
- type: string
- type: 'null'
title: Run Name
title: WandbIntegration
required:
- project
- api_key
CheckpointOut:
type: object
properties:
metrics:
$ref: '#/components/schemas/MetricOut'
step_number:
type: integer
title: Step Number
description: The step number that the checkpoint was created at.
created_at:
type: integer
examples:
- 1716963433
title: Created At
description: The UNIX timestamp (in seconds) for when the checkpoint was created.
title: CheckpointOut
required:
- metrics
- step_number
- created_at
ClassifierDetailedJobOut:
type: object
properties:
id:
type: string
title: Id
format: uuid
auto_start:
type: boolean
title: Auto Start
model:
type: string
title: Model
status:
type: string
title: Status
enum:
- QUEUED
- STARTED
- VALIDATING
- VALIDATED
- RUNNING
- FAILED_VALIDATION
- FAILED
- SUCCESS
- CANCELLED
- CANCELLATION_REQUESTED
created_at:
type: integer
title: Created At
modified_at:
type: integer
title: Modified At
training_files:
type: array
items:
type: string
format: uuid
title: Training Files
validation_files:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Validation Files
default: []
object:
type: string
title: Object
default: job
const: job
fine_tuned_model:
anyOf:
- type: string
- type: 'null'
title: Fine Tuned Model
suffix:
anyOf:
- type: string
- type: 'null'
title: Suffix
integrations:
anyOf:
- type: array
items:
oneOf:
- $ref: '#/components/schemas/WandbIntegrationOut'
discriminator:
propertyName: type
mapping:
wandb: '#/components/schemas/WandbIntegrationOut'
- type: 'null'
title: Integrations
trained_tokens:
anyOf:
- type: integer
- type: 'null'
title: Trained Tokens
metadata:
anyOf:
- $ref: '#/components/schemas/JobMetadataOut'
- type: 'null'
job_type:
type: string
title: Job Type
default: classifier
const: classifier
hyperparameters:
$ref: '#/components/schemas/ClassifierTrainingParameters'
events:
type: array
items:
$ref: '#/components/schemas/EventOut'
title: Events
description: Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here.
default: []
checkpoints:
type: array
items:
$ref: '#/components/schemas/CheckpointOut'
title: Checkpoints
default: []
classifier_targets:
type: array
items:
$ref: '#/components/schemas/ClassifierTargetOut'
title: Classifier Targets
title: ClassifierDetailedJobOut
required:
- id
- auto_start
- model
- status
- created_at
- modified_at
- training_files
- hyperparameters
- classifier_targets
ClassifierTargetOut:
type: object
properties:
name:
type: string
title: Name
labels:
type: array
items:
type: string
title: Labels
weight:
type: number
title: Weight
loss_function:
$ref: '#/components/schemas/FTClassifierLossFunction'
title: ClassifierTargetOut
required:
- name
- labels
- weight
- loss_function
CompletionDetailedJobOut:
type: object
properties:
id:
type: string
title: Id
format: uuid
auto_start:
type: boolean
title: Auto Start
model:
type: string
title: Model
status:
type: string
title: Status
enum:
- QUEUED
- STARTED
- VALIDATING
- VALIDATED
- RUNNING
- FAILED_VALIDATION
- FAILED
- SUCCESS
- CANCELLED
- CANCELLATION_REQUESTED
created_at:
type: integer
title: Created At
modified_at:
type: integer
title: Modified At
training_files:
type: array
items:
type: string
format: uuid
title: Training Files
validation_files:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Validation Files
default: []
object:
type: string
title: Object
default: job
const: job
fine_tuned_model:
anyOf:
- type: string
- type: 'null'
title: Fine Tuned Model
suffix:
anyOf:
- type: string
- type: 'null'
title: Suffix
integrations:
anyOf:
- type: array
items:
oneOf:
- $ref: '#/components/schemas/WandbIntegrationOut'
discriminator:
propertyName: type
mapping:
wandb: '#/components/schemas/WandbIntegrationOut'
- type: 'null'
title: Integrations
trained_tokens:
anyOf:
- type: integer
- type: 'null'
title: Trained Tokens
metadata:
anyOf:
- $ref: '#/components/schemas/JobMetadataOut'
- type: 'null'
job_type:
type: string
title: Job Type
default: completion
const: completion
hyperparameters:
$ref: '#/components/schemas/CompletionTrainingParameters'
repositories:
type: array
items:
oneOf:
- $ref: '#/components/schemas/GithubRepositoryOut'
discriminator:
propertyName: type
mapping:
github: '#/components/schemas/GithubRepositoryOut'
title: Repositories
default: []
events:
type: array
items:
$ref: '#/components/schemas/EventOut'
title: Events
description: Event items are created every time the status of a fine-tuning job changes. The timestamped list of all events is accessible here.
default: []
checkpoints:
type: array
items:
$ref: '#/components/schemas/CheckpointOut'
title: Checkpoints
default: []
title: CompletionDetailedJobOut
required:
- id
- auto_start
- model
- status
- created_at
- modified_at
- training_files
- hyperparameters
EventOut:
type: object
properties:
name:
type: string
title: Name
description: The name of the event.
data:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Data
created_at:
type: integer
title: Created At
description: The UNIX timestamp (in seconds) of the event.
title: EventOut
required:
- name
- created_at
MetricOut:
type: object
properties:
train_loss:
anyOf:
- type: number
- type: 'null'
title: Train Loss
valid_loss:
anyOf:
- type: number
- type: 'null'
title: Valid Loss
valid_mean_token_accuracy:
anyOf:
- type: number
- type: 'null'
title: Valid Mean Token Accuracy
title: MetricOut
description: Metrics at the step number during the fine-tuning job. Use these metrics to assess if the training is going smoothly (loss should decrease, token accuracy should increase).
ClassifierFTModelOut:
type: object
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: model
const: model
created:
type: integer
title: Created
owned_by:
type: string
title: Owned By
workspace_id:
type: string
title: Workspace Id
root:
type: string
title: Root
root_version:
type: string
title: Root Version
archived:
type: boolean
title: Archived
name:
anyOf:
- type: string
- type: 'null'
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
capabilities:
$ref: '#/components/schemas/FTModelCapabilitiesOut'
max_context_length:
type: integer
title: Max Context Length
default: 32768
aliases:
type: array
items:
type: string
title: Aliases
default: []
job:
type: string
title: Job
format: uuid
classifier_targets:
type: array
items:
$ref: '#/components/schemas/ClassifierTargetOut'
title: Classifier Targets
model_type:
type: string
title: Model Type
default: classifier
const: classifier
title: ClassifierFTModelOut
required:
- id
- created
- owned_by
- workspace_id
- root
- root_version
- archived
- capabilities
- job
- classifier_targets
CompletionFTModelOut:
type: object
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: model
const: model
created:
type: integer
title: Created
owned_by:
type: string
title: Owned By
workspace_id:
type: string
title: Workspace Id
root:
type: string
title: Root
root_version:
type: string
title: Root Version
archived:
type: boolean
title: Archived
name:
anyOf:
- type: string
- type: 'null'
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
capabilities:
$ref: '#/components/schemas/FTModelCapabilitiesOut'
max_context_length:
type: integer
title: Max Context Length
default: 32768
aliases:
type: array
items:
type: string
title: Aliases
default: []
job:
type: string
title: Job
format: uuid
model_type:
type: string
title: Model Type
default: completion
const: completion
title: CompletionFTModelOut
required:
- id
- created
- owned_by
- workspace_id
- root
- root_version
- archived
- capabilities
- job
FTModelCapabilitiesOut:
type: object
properties:
completion_chat:
type: boolean
title: Completion Chat
default: true
completion_fim:
type: boolean
title: Completion Fim
default: false
function_calling:
type: boolean
title: Function Calling
default: false
fine_tuning:
type: boolean
title: Fine Tuning
default: false
classification:
type: boolean
title: Classification
default: false
title: FTModelCapabilitiesOut
UpdateFTModelIn:
type: object
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
title: UpdateFTModelIn
ArchiveFTModelOut:
type: object
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: model
const: model
archived:
type: boolean
title: Archived
default: true
title: ArchiveFTModelOut
required:
- id
UnarchiveFTModelOut:
type: object
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: model
const: model
archived:
type: boolean
title: Archived
default: false
title: UnarchiveFTModelOut
required:
- id
BatchJobStatus:
type: string
title: BatchJobStatus
enum:
- QUEUED
- RUNNING
- SUCCESS
- FAILED
- TIMEOUT_EXCEEDED
- CANCELLATION_REQUESTED
- CANCELLED
BatchError:
type: object
properties:
message:
type: string
title: Message
count:
type: integer
title: Count
default: 1
title: BatchError
required:
- message
BatchJobOut:
type: object
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: batch
const: batch
input_files:
type: array
items:
type: string
format: uuid
title: Input Files
metadata:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Metadata
endpoint:
type: string
title: Endpoint
model:
anyOf:
- type: string
- type: 'null'
title: Model
agent_id:
anyOf:
- type: string
- type: 'null'
title: Agent Id
output_file:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Output File
error_file:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Error File
errors:
type: array
items:
$ref: '#/components/schemas/BatchError'
title: Errors
outputs:
anyOf:
- type: array
items:
type: object
additionalProperties: true
- type: 'null'
title: Outputs
status:
$ref: '#/components/schemas/BatchJobStatus'
created_at:
type: integer
title: Created At
total_requests:
type: integer
title: Total Requests
completed_requests:
type: integer
title: Completed Requests
succeeded_requests:
type: integer
title: Succeeded Requests
failed_requests:
type: integer
title: Failed Requests
started_at:
anyOf:
- type: integer
- type: 'null'
title: Started At
completed_at:
anyOf:
- type: integer
- type: 'null'
title: Completed At
title: BatchJobOut
required:
- id
- input_files
- endpoint
- errors
- status
- created_at
- total_requests
- completed_requests
- succeeded_requests
- failed_requests
BatchJobsOut:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/BatchJobOut'
title: Data
default: []
object:
type: string
title: Object
default: list
const: list
total:
type: integer
title: Total
title: BatchJobsOut
required:
- total
ApiEndpoint:
type: string
title: ApiEndpoint
enum:
- /v1/chat/completions
- /v1/embeddings
- /v1/fim/completions
- /v1/moderations
- /v1/chat/moderations
- /v1/ocr
- /v1/classifications
- /v1/chat/classifications
- /v1/conversations
- /v1/audio/transcriptions
BatchJobIn:
type: object
properties:
input_files:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Input Files
description: 'The list of input files to be used for batch inference, these files should be `jsonl` files, containing the input data corresponding to the bory request for the batch inference in a "body" field. An example of such file is the following: ```json {"custom_id": "0", "body": {"max_tokens": 100, "messages": [{"role": "user", "content": "What is the best French cheese?"}]}} {"custom_id": "1", "body": {"max_tokens": 100, "messages": [{"role": "user", "content": "What is the best French wine?"}]}} ```'
requests:
anyOf:
- type: array
items:
$ref: '#/components/schemas/BatchRequest'
maxItems: 10000
- type: 'null'
title: Requests
endpoint:
$ref: '#/components/schemas/ApiEndpoint'
examples:
- /v1/chat/completions
- /v1/embeddings
- /v1/fim/completions
description: The endpoint to be used for batch inference.
model:
anyOf:
- type: string
- type: 'null'
examples:
- mistral-small-latest
- mistral-medium-latest
title: Model
description: The model to be used for batch inference.
agent_id:
anyOf:
- type: string
- type: 'null'
title: Agent Id
description: In case you want to use a specific agent from the **deprecated** agents api for batch inference, you can specify the agent ID here.
metadata:
anyOf:
- type: object
propertyNames:
maxLength: 32
minLength: 1
additionalProperties:
type: string
maxLength: 512
minLength: 1
- type: 'null'
title: Metadata
description: The metadata of your choice to be associated with the batch inference job.
timeout_hours:
type: integer
title: Timeout Hours
description: The timeout in hours for the batch inference job.
default: 24
title: BatchJobIn
required:
- endpoint
BatchRequest:
type: object
properties:
custom_id:
anyOf:
- type: string
- type: 'null'
title: Custom Id
body:
type: object
title: Body
additionalProperties: true
title: BatchRequest
required:
- body
AssistantMessage:
type: object
properties:
role:
type: string
title: Role
default: assistant
const: assistant
content:
anyOf:
- type: string
- type: 'null'
- type: array
items:
$ref: '#/components/schemas/ContentChunk'
title: Content
tool_calls:
anyOf:
- type: array
items:
$ref: '#/components/schemas/ToolCall'
- type: 'null'
title: Tool Calls
prefix:
type: boolean
title: Prefix
description: Set this to `true` when adding an assistant message as prefix to condition the model response. The role of the prefix message is to force the model to start its answer by the content of the message.
default: false
title: AssistantMessage
additionalProperties: false
AudioChunk:
type: object
properties:
type:
type: string
title: Type
default: input_audio
const: input_audio
input_audio:
anyOf:
- type: string
- type: string
format: binary
title: Input Audio
title: AudioChunk
required:
- input_audio
additionalProperties: false
ChatCompletionRequest:
type: object
properties:
model:
type: string
examples:
- mistral-large-latest
title: Model
description: ID of the model to use. You can use the [List Available Models](/api/#tag/models/operation/list_models_v1_models_get) API to see all of your available models, or see our [Model overview](/models) for model descriptions.
temperature:
anyOf:
- type: number
maximum: 1.5
minimum: 0
- type: 'null'
title: Temperature
description: What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value.
top_p:
type: number
title: Top P
maximum: 1
minimum: 0
description: Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both.
default: 1.0
max_tokens:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Max Tokens
description: The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length.
stream:
type: boolean
title: Stream
description: 'Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.'
default: false
stop:
anyOf:
- type: string
- type: array
items:
type: string
title: Stop
description: Stop generation if this token is detected. Or if one of these tokens is detected when providing an array
random_seed:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Random Seed
description: The seed to use for random sampling. If set, different calls will generate deterministic results.
metadata:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Metadata
messages:
type: array
examples:
- - role: user
content: Who is the best French painter? Answer in one short sentence.
items:
oneOf:
- $ref: '#/components/schemas/SystemMessage'
- $ref: '#/components/schemas/UserMessage'
- $ref: '#/components/schemas/AssistantMessage'
- $ref: '#/components/schemas/ToolMessage'
discriminator:
propertyName: role
mapping:
assistant: '#/components/schemas/AssistantMessage'
system: '#/components/schemas/SystemMessage'
tool: '#/components/schemas/ToolMessage'
user: '#/components/schemas/UserMessage'
title: Messages
description: The prompt(s) to generate completions for, encoded as a list of dict with role and content.
response_format:
$ref: '#/components/schemas/ResponseFormat'
tools:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Tool'
- type: 'null'
title: Tools
description: A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for.
tool_choice:
anyOf:
- $ref: '#/components/schemas/ToolChoice'
- $ref: '#/components/schemas/ToolChoiceEnum'
title: Tool Choice
description: 'Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `any` or `required` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.'
default: auto
presence_penalty:
type: number
title: Presence Penalty
maximum: 2
minimum: -2
description: The `presence_penalty` determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative.
default: 0.0
frequency_penalty:
type: number
title: Frequency Penalty
maximum: 2
minimum: -2
description: The `frequency_penalty` penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition.
default: 0.0
n:
anyOf:
- type: integer
minimum: 1
- type: 'null'
title: N
description: Number of completions to return for each request, input tokens are only billed once.
prediction:
$ref: '#/components/schemas/Prediction'
description: Enable users to specify expected results, optimizing response times by leveraging known or predictable content. This approach is especially effective for updating text documents or code files with minimal changes, reducing latency while maintaining high-quality results.
default:
type: content
content: ''
parallel_tool_calls:
type: boolean
title: Parallel Tool Calls
description: Whether to enable parallel function calling during tool use, when enabled the model can call multiple tools in parallel.
default: true
prompt_mode:
anyOf:
- $ref: '#/components/schemas/MistralPromptMode'
- type: 'null'
description: Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. **Deprecated for reasoning models - use `reasoning_effort` parameter instead.**
reasoning_effort:
type: string
enum:
- high
- none
description: Controls the reasoning effort level for reasoning models. "high" enables comprehensive reasoning traces, "none" disables reasoning effort.
guardrails:
anyOf:
- type: array
items:
$ref: '#/components/schemas/GuardrailConfig'
- type: 'null'
title: Guardrails
description: A list of guardrail configurations to apply to this request. Each guardrail specifies a moderation type, categories with thresholds to evaluate, and an action to take on violation.
default: null
prompt_cache_key:
anyOf:
- type: string
- type: 'null'
title: Prompt Cache Key
description: A cache key to enable prompt caching. When provided, the API will attempt to reuse previously computed tokens for requests sharing the same prefix (e.g. multi-turn conversations or requests with a similar system prompt). Cached tokens are billed at 10% of the standard input token price.
safe_prompt:
type: boolean
description: Whether to inject a safety prompt before all conversations.
default: false
title: ChatCompletionRequest
required:
- messages
- model
additionalProperties: false
ChatModerationRequest:
type: object
properties:
input:
anyOf:
- type: array
items:
oneOf:
- $ref: '#/components/schemas/SystemMessage'
- $ref: '#/components/schemas/UserMessage'
- $ref: '#/components/schemas/AssistantMessage'
- $ref: '#/components/schemas/ToolMessage'
discriminator:
propertyName: role
mapping:
assistant: '#/components/schemas/AssistantMessage'
system: '#/components/schemas/SystemMessage'
tool: '#/components/schemas/ToolMessage'
user: '#/components/schemas/UserMessage'
- type: array
items:
type: array
items:
oneOf:
- $ref: '#/components/schemas/SystemMessage'
- $ref: '#/components/schemas/UserMessage'
- $ref: '#/components/schemas/AssistantMessage'
- $ref: '#/components/schemas/ToolMessage'
discriminator:
propertyName: role
mapping:
assistant: '#/components/schemas/AssistantMessage'
system: '#/components/schemas/SystemMessage'
tool: '#/components/schemas/ToolMessage'
user: '#/components/schemas/UserMessage'
title: Input
description: Chat to classify
model:
type: string
title: Model
title: ChatModerationRequest
required:
- input
- model
additionalProperties: false
ClassificationRequest:
type: object
properties:
model:
type: string
examples:
- mistral-moderation-latest
title: Model
description: ID of the model to use.
metadata:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Metadata
input:
anyOf:
- type: string
- type: array
items:
type: string
title: Input
description: Text to classify.
title: ClassificationRequest
required:
- input
- model
additionalProperties: false
EmbeddingDtype:
type: string
title: EmbeddingDtype
enum:
- float
- int8
- uint8
- binary
- ubinary
EmbeddingRequest:
type: object
properties:
model:
type: string
title: Model
description: ID of the model to use.
example: mistral-embed
metadata:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Metadata
input:
anyOf:
- type: string
- type: array
items:
type: string
title: Input
description: Text to embed.
example:
- Embed this sentence.
- As well as this one.
output_dimension:
anyOf:
- exclusiveMinimum: 0
type: integer
- type: 'null'
title: Output Dimension
description: The dimension of the output embeddings when feature available. If not provided, a default output dimension will be used.
output_dtype:
$ref: '#/components/schemas/EmbeddingDtype'
description: The data type of the output embeddings when feature available. If not provided, a default output data type will be used.
default: float
encoding_format:
$ref: '#/components/schemas/EncodingFormat'
description: The format of embeddings in the response.
default: float
title: EmbeddingRequest
required:
- input
- model
additionalProperties: false
EncodingFormat:
type: string
title: EncodingFormat
enum:
- float
- base64
FIMCompletionRequest:
type: object
properties:
model:
type: string
examples:
- codestral-latest
title: Model
description: ID of the model with FIM to use.
default: codestral-2404
temperature:
anyOf:
- type: number
maximum: 1.5
minimum: 0
- type: 'null'
title: Temperature
description: What sampling temperature to use, we recommend between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. The default value varies depending on the model you are targeting. Call the `/models` endpoint to retrieve the appropriate value.
top_p:
type: number
title: Top P
maximum: 1
minimum: 0
description: Nucleus sampling, where the model considers the results of the tokens with `top_p` probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both.
default: 1.0
max_tokens:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Max Tokens
description: The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length.
stream:
type: boolean
title: Stream
description: 'Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.'
default: false
stop:
anyOf:
- type: string
- type: array
items:
type: string
title: Stop
description: Stop generation if this token is detected. Or if one of these tokens is detected when providing an array
random_seed:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Random Seed
description: The seed to use for random sampling. If set, different calls will generate deterministic results.
metadata:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Metadata
prompt:
type: string
examples:
- def
title: Prompt
description: The text/code to complete.
suffix:
anyOf:
- type: string
- type: 'null'
examples:
- return a+b
title: Suffix
description: Optional text/code that adds more context for the model. When given a `prompt` and a `suffix` the model will fill what is between them. When `suffix` is not provided, the model will simply execute completion starting with `prompt`.
default: ''
min_tokens:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Min Tokens
description: The minimum number of tokens to generate in the completion.
prompt_cache_key:
anyOf:
- type: string
- type: 'null'
title: Prompt Cache Key
description: A cache key to enable prompt caching. When provided, the API will attempt to reuse previously computed tokens for requests sharing the same prefix (e.g. multi-turn conversations or requests with a similar system prompt). Cached tokens are billed at 10% of the standard input token price.
title: FIMCompletionRequest
required:
- prompt
- model
additionalProperties: false
FileChunk:
type: object
properties:
type:
type: string
title: Type
default: file
const: file
file_id:
type: string
title: File Id
format: uuid
title: FileChunk
required:
- file_id
additionalProperties: false
FunctionCall:
type: object
properties:
name:
type: string
title: Name
arguments:
title: Arguments
anyOf:
- type: object
additionalProperties: true
- type: string
title: FunctionCall
required:
- name
- arguments
additionalProperties: false
FunctionName:
type: object
properties:
name:
type: string
title: Name
title: FunctionName
required:
- name
additionalProperties: false
description: this restriction of `Function` is used to select a specific function to call
InstructRequest:
type: object
properties:
messages:
type: array
items:
oneOf:
- $ref: '#/components/schemas/SystemMessage'
- $ref: '#/components/schemas/UserMessage'
- $ref: '#/components/schemas/AssistantMessage'
- $ref: '#/components/schemas/ToolMessage'
discriminator:
propertyName: role
mapping:
assistant: '#/components/schemas/AssistantMessage'
system: '#/components/schemas/SystemMessage'
tool: '#/components/schemas/ToolMessage'
user: '#/components/schemas/UserMessage'
title: Messages
title: InstructRequest
required:
- messages
additionalProperties: false
MistralPromptMode:
type: string
title: MistralPromptMode
enum:
- reasoning
description: 'Available options to the prompt_mode argument on the chat completion endpoint.
Values represent high-level intent. Assignment to actual SPs is handled internally.
System prompt may include knowledge cutoff date, model capabilities, tone to use, safety guidelines, etc.'
OCRConfidenceScore:
type: object
properties:
text:
type: string
title: Text
description: The word or text segment
confidence:
type: number
title: Confidence
maximum: 1
minimum: 0
description: Confidence score (0-1)
start_index:
type: integer
title: Start Index
minimum: 0
description: Start index of the text in the page markdown string
title: OCRConfidenceScore
required:
- text
- confidence
- start_index
additionalProperties: false
description: Confidence score for a token or word in OCR output.
OCRImageObject:
type: object
properties:
id:
type: string
title: Id
description: Image ID for extracted image in a page
top_left_x:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Top Left X
description: X coordinate of top-left corner of the extracted image
top_left_y:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Top Left Y
description: Y coordinate of top-left corner of the extracted image
bottom_right_x:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Bottom Right X
description: X coordinate of bottom-right corner of the extracted image
bottom_right_y:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Bottom Right Y
description: Y coordinate of bottom-right corner of the extracted image
image_base64:
anyOf:
- type: string
- type: 'null'
title: Image Base64
description: Base64 string of the extracted image
image_annotation:
anyOf:
- type: string
- type: 'null'
title: Image Annotation
description: Annotation of the extracted image in json str
title: OCRImageObject
required:
- id
- top_left_x
- top_left_y
- bottom_right_x
- bottom_right_y
additionalProperties: false
OCRPageConfidenceScores:
type: object
properties:
word_confidence_scores:
type: array
items:
$ref: '#/components/schemas/OCRConfidenceScore'
title: Word Confidence Scores
description: Word-level confidence scores (populated only for 'word' granularity)
average_page_confidence_score:
type: number
title: Average Page Confidence Score
maximum: 1
minimum: 0
description: Average confidence score for the page
minimum_page_confidence_score:
type: number
title: Minimum Page Confidence Score
maximum: 1
minimum: 0
description: Minimum confidence score for the page
title: OCRPageConfidenceScores
required:
- average_page_confidence_score
- minimum_page_confidence_score
additionalProperties: false
description: Confidence scores for an OCR page at various granularities.
OCRPageDimensions:
type: object
properties:
dpi:
type: integer
title: Dpi
minimum: 0
description: Dots per inch of the page-image
height:
type: integer
title: Height
minimum: 0
description: Height of the image in pixels
width:
type: integer
title: Width
minimum: 0
description: Width of the image in pixels
title: OCRPageDimensions
required:
- dpi
- height
- width
additionalProperties: false
OCRPageObject:
type: object
properties:
index:
type: integer
title: Index
minimum: 0
description: The page index in a pdf document starting from 0
markdown:
type: string
title: Markdown
description: The markdown string response of the page
images:
type: array
items:
$ref: '#/components/schemas/OCRImageObject'
title: Images
description: List of all extracted images in the page
tables:
type: array
items:
$ref: '#/components/schemas/OCRTableObject'
title: Tables
description: List of all extracted tables in the page
hyperlinks:
type: array
items:
type: string
title: Hyperlinks
description: List of all hyperlinks in the page
header:
anyOf:
- type: string
- type: 'null'
title: Header
description: Header of the page
footer:
anyOf:
- type: string
- type: 'null'
title: Footer
description: Footer of the page
dimensions:
anyOf:
- $ref: '#/components/schemas/OCRPageDimensions'
- type: 'null'
description: The dimensions of the PDF Page's screenshot image
confidence_scores:
anyOf:
- $ref: '#/components/schemas/OCRPageConfidenceScores'
- type: 'null'
description: Confidence scores for the OCR page (populated when confidence_scores_granularity is set)
title: OCRPageObject
required:
- index
- markdown
- images
- dimensions
additionalProperties: false
OCRRequest:
type: object
properties:
model:
anyOf:
- type: string
- type: 'null'
title: Model
id:
type: string
title: Id
document:
anyOf:
- $ref: '#/components/schemas/FileChunk'
- $ref: '#/components/schemas/DocumentURLChunk'
- $ref: '#/components/schemas/ImageURLChunk'
title: Document
description: Document to run OCR on
pages:
anyOf:
- type: array
items:
type: integer
- type: 'null'
title: Pages
description: 'Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0'
include_image_base64:
anyOf:
- type: boolean
- type: 'null'
title: Include Image Base64
description: Include image URLs in response
image_limit:
anyOf:
- type: integer
- type: 'null'
title: Image Limit
description: Max images to extract
image_min_size:
anyOf:
- type: integer
- type: 'null'
title: Image Min Size
description: Minimum height and width of image to extract
bbox_annotation_format:
anyOf:
- $ref: '#/components/schemas/ResponseFormat'
- type: 'null'
description: Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field
document_annotation_format:
anyOf:
- $ref: '#/components/schemas/ResponseFormat'
- type: 'null'
description: Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field
document_annotation_prompt:
anyOf:
- type: string
- type: 'null'
title: Document Annotation Prompt
description: Optional prompt to guide the model in extracting structured output from the entire document. A document_annotation_format must be provided.
table_format:
anyOf:
- type: string
enum:
- markdown
- html
- type: 'null'
title: Table Format
extract_header:
type: boolean
title: Extract Header
default: false
extract_footer:
type: boolean
title: Extract Footer
default: false
confidence_scores_granularity:
anyOf:
- type: string
enum:
- word
- page
- type: 'null'
description: 'Granularity for confidence scores: ''word'' (per-word scores) or ''page'' (aggregate only). Defaults to None (no confidence scores) to keep response payload small.'
title: OCRRequest
required:
- document
- model
additionalProperties: false
OCRResponse:
type: object
properties:
pages:
type: array
items:
$ref: '#/components/schemas/OCRPageObject'
title: Pages
description: List of OCR info for pages.
model:
type: string
title: Model
description: The model used to generate the OCR.
document_annotation:
anyOf:
- type: string
- type: 'null'
title: Document Annotation
description: Formatted response in the request_format if provided in json str
usage_info:
$ref: '#/components/schemas/OCRUsageInfo'
description: Usage info for the OCR request.
title: OCRResponse
required:
- pages
- model
- usage_info
additionalProperties: false
OCRTableObject:
type: object
properties:
id:
type: string
title: Id
description: Table ID for extracted table in a page
content:
type: string
title: Content
description: Content of the table in the given format
format:
type: string
title: Format
enum:
- markdown
- html
description: Format of the table
word_confidence_scores:
anyOf:
- type: array
items:
$ref: '#/components/schemas/OCRConfidenceScore'
- type: 'null'
title: Word Confidence Scores
description: Per-word confidence scores for the table content. Returned when confidence_scores_granularity is set to 'word'.
title: OCRTableObject
required:
- id
- content
- format
additionalProperties: false
OCRUsageInfo:
type: object
properties:
pages_processed:
type: integer
title: Pages Processed
minimum: 0
description: Number of pages processed
doc_size_bytes:
anyOf:
- type: integer
- type: 'null'
title: Doc Size Bytes
description: Document size in bytes
title: OCRUsageInfo
required:
- pages_processed
additionalProperties: false
SystemMessage:
type: object
properties:
role:
type: string
title: Role
default: system
const: system
content:
anyOf:
- type: string
- type: array
items:
$ref: '#/components/schemas/SystemMessageContentChunks'
title: Content
title: SystemMessage
required:
- content
additionalProperties: false
Tool:
type: object
properties:
type:
$ref: '#/components/schemas/ToolTypes'
default: function
function:
$ref: '#/components/schemas/Function'
title: Tool
required:
- function
additionalProperties: false
ToolCall:
type: object
properties:
id:
type: string
title: Id
default: 'null'
type:
$ref: '#/components/schemas/ToolTypes'
default: function
function:
$ref: '#/components/schemas/FunctionCall'
index:
type: integer
title: Index
default: 0
title: ToolCall
required:
- function
additionalProperties: false
ToolChoice:
type: object
properties:
type:
$ref: '#/components/schemas/ToolTypes'
default: function
function:
$ref: '#/components/schemas/FunctionName'
title: ToolChoice
required:
- function
additionalProperties: false
description: ToolChoice is either a ToolChoiceEnum or a ToolChoice
ToolMessage:
type: object
properties:
role:
type: string
title: Role
default: tool
const: tool
content:
anyOf:
- type: string
- type: 'null'
- type: array
items:
$ref: '#/components/schemas/ContentChunk'
title: Content
tool_call_id:
anyOf:
- type: string
- type: 'null'
title: Tool Call Id
name:
anyOf:
- type: string
- type: 'null'
title: Name
title: ToolMessage
required:
- content
additionalProperties: false
ToolTypes:
type: string
title: ToolTypes
enum:
- function
TranscriptionResponse:
type: object
properties:
model:
type: string
title: Model
text:
type: string
title: Text
language:
anyOf:
- type: string
pattern: ^\w{2}$
- type: 'null'
title: Language
segments:
type: array
items:
$ref: '#/components/schemas/TranscriptionSegmentChunk'
title: Segments
usage:
$ref: '#/components/schemas/UsageInfo'
title: TranscriptionResponse
required:
- model
- text
- language
- usage
additionalProperties: false
TranscriptionSegmentChunk:
type: object
properties:
type:
type: string
title: Type
default: transcription_segment
const: transcription_segment
text:
type: string
title: Text
start:
type: number
title: Start
end:
type: number
title: End
score:
anyOf:
- type: number
- type: 'null'
title: Score
speaker_id:
anyOf:
- type: string
- type: 'null'
title: Speaker Id
title: TranscriptionSegmentChunk
required:
- text
- start
- end
additionalProperties: false
PromptTokensDetails:
properties:
cached_tokens:
type: integer
title: Cached Tokens
default: 0
additionalProperties: false
type: object
title: PromptTokensDetails
description: Token usage details for the prompt.
UsageInfo:
type: object
properties:
prompt_tokens:
type: integer
title: Prompt Tokens
default: 0
completion_tokens:
title: Completion Tokens
default: 0
type: integer
total_tokens:
type: integer
title: Total Tokens
default: 0
prompt_audio_seconds:
anyOf:
- type: integer
- type: 'null'
title: Prompt Audio Seconds
num_cached_tokens:
anyOf:
- type: integer
- type: 'null'
title: Num Cached Tokens
prompt_tokens_details:
anyOf:
- $ref: '#/components/schemas/PromptTokensDetails'
- type: 'null'
prompt_token_details:
anyOf:
- $ref: '#/components/schemas/PromptTokensDetails'
- type: 'null'
title: UsageInfo
additionalProperties: false
required:
- prompt_tokens
- completion_tokens
- total_tokens
SpeechRequest:
properties:
model:
anyOf:
- type: string
- type: 'null'
title: Model
stream:
type: boolean
title: Stream
default: false
voice_id:
anyOf:
- type: string
- type: 'null'
title: Voice Id
description: The preset or custom voice to use for generating the speech.
ref_audio:
anyOf:
- type: string
- type: 'null'
title: Ref Audio
description: The base64-encoded audio reference for zero-shot voice cloning.
input:
type: string
title: Input
description: Text to generate speech from.
response_format:
$ref: '#/components/schemas/SpeechOutputFormat'
description: Output audio format. Defaults to mp3.
default: mp3
additionalProperties: true
type: object
required:
- input
title: SpeechRequest
SpeechOutputFormat:
type: string
enum:
- pcm
- wav
- mp3
- flac
- opus
title: SpeechOutputFormat
SpeechResponse:
properties:
audio_data:
type: string
title: Audio Data
description: Base64 encoded audio data
additionalProperties: false
type: object
required:
- audio_data
title: SpeechResponse
SpeechStreamAudioDelta:
properties:
type:
type: string
const: speech.audio.delta
title: Type
default: speech.audio.delta
audio_data:
type: string
title: Audio Data
additionalProperties: false
type: object
required:
- audio_data
title: SpeechStreamAudioDelta
SpeechStreamDone:
properties:
type:
type: string
const: speech.audio.done
title: Type
default: speech.audio.done
usage:
$ref: '#/components/schemas/UsageInfo'
additionalProperties: false
type: object
required:
- usage
title: SpeechStreamDone
SpeechStreamEvents:
properties:
event:
type: string
enum:
- speech.audio.delta
- speech.audio.done
title: Event
data:
oneOf:
- $ref: '#/components/schemas/SpeechStreamAudioDelta'
- $ref: '#/components/schemas/SpeechStreamDone'
title: Data
discriminator:
propertyName: type
mapping:
speech.audio.delta: '#/components/schemas/SpeechStreamAudioDelta'
speech.audio.done: '#/components/schemas/SpeechStreamDone'
additionalProperties: false
type: object
required:
- event
- data
title: SpeechStreamEvents
VoiceCreateRequest:
type: object
properties:
name:
type: string
title: Name
slug:
anyOf:
- type: string
- type: 'null'
title: Slug
languages:
type: array
items:
type: string
title: Languages
default: []
gender:
anyOf:
- type: string
- type: 'null'
title: Gender
age:
anyOf:
- type: integer
- type: 'null'
title: Age
tags:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Tags
color:
anyOf:
- type: string
- type: 'null'
title: Color
retention_notice:
type: integer
title: Retention Notice
default: 30
sample_audio:
type: string
title: Sample Audio
description: Base64-encoded audio file
sample_filename:
anyOf:
- type: string
- type: 'null'
title: Sample Filename
description: Original filename for extension detection
title: VoiceCreateRequest
required:
- name
- sample_audio
description: Request model for creating a new voice with base64 audio.
VoiceListResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/VoiceResponse'
title: Items
total:
type: integer
title: Total
page:
type: integer
title: Page
page_size:
type: integer
title: Page Size
total_pages:
type: integer
title: Total Pages
title: VoiceListResponse
required:
- items
- total
- page
- page_size
- total_pages
description: Schema for voice list response
VoiceResponse:
type: object
properties:
name:
type: string
title: Name
slug:
anyOf:
- type: string
- type: 'null'
title: Slug
languages:
type: array
items:
type: string
title: Languages
default: []
gender:
anyOf:
- type: string
- type: 'null'
title: Gender
age:
anyOf:
- type: integer
- type: 'null'
title: Age
tags:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Tags
color:
anyOf:
- type: string
- type: 'null'
title: Color
retention_notice:
type: integer
title: Retention Notice
default: 30
id:
type: string
title: Id
format: uuid
created_at:
type: string
title: Created At
format: date-time
user_id:
anyOf:
- type: string
- type: 'null'
title: User Id
title: VoiceResponse
required:
- name
- id
- created_at
- user_id
description: Schema for voice response
VoiceUpdateRequest:
type: object
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
languages:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Languages
gender:
anyOf:
- type: string
- type: 'null'
title: Gender
age:
anyOf:
- type: integer
- type: 'null'
title: Age
tags:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Tags
title: VoiceUpdateRequest
description: Request model for partially updating voice metadata.
UserMessage:
type: object
properties:
role:
type: string
title: Role
default: user
const: user
content:
anyOf:
- type: string
- type: 'null'
- type: array
items:
$ref: '#/components/schemas/ContentChunk'
title: Content
title: UserMessage
required:
- content
additionalProperties: false
File:
type: string
title: File
format: binary
description: "The File object (not file name) to be uploaded.\n To upload a file and specify a custom file name you should format your request as such:\n ```bash\n file=@path/to/your/file.jsonl;filename=custom_name.jsonl\n ```\n Otherwise, you can just keep the original file name:\n ```bash\n file=@path/to/your/file.jsonl\n ```"
TimestampGranularity:
type: string
title: TimestampGranularity
enum:
- segment
- word
AudioTranscriptionRequest:
type: object
properties:
model:
type: string
examples:
- voxtral-mini-latest
- voxtral-mini-2507
title: Model
description: ID of the model to be used.
file:
anyOf:
- $ref: '#/components/schemas/File'
- type: 'null'
title: File
default: null
file_url:
anyOf:
- type: string
maxLength: 2083
minLength: 1
format: uri
- type: 'null'
title: File Url
description: Url of a file to be transcribed
default: null
file_id:
anyOf:
- type: string
- type: 'null'
title: File Id
description: ID of a file uploaded to /v1/files
default: null
language:
anyOf:
- type: string
pattern: ^\w{2}$
- type: 'null'
title: Language
description: Language of the audio, e.g. 'en'. Providing the language can boost accuracy.
default: null
temperature:
anyOf:
- type: number
- type: 'null'
title: Temperature
default: null
stream:
type: boolean
title: Stream
default: false
const: false
diarize:
type: boolean
title: Diarize
default: false
context_bias:
type: array
items:
type: string
pattern: ^[^,\s]+$
title: Context Bias
default: []
timestamp_granularities:
type: array
items:
$ref: '#/components/schemas/TimestampGranularity'
title: Timestamp Granularities
description: Granularities of timestamps to include in the response.
$defs:
TimestampGranularity:
type: string
title: TimestampGranularity
enum:
- segment
- word
title: AudioTranscriptionRequest
required:
- model
AudioTranscriptionRequestStream:
type: object
properties:
model:
type: string
title: Model
file:
anyOf:
- $ref: '#/components/schemas/File'
- type: 'null'
title: File
default: null
file_url:
anyOf:
- type: string
maxLength: 2083
minLength: 1
format: uri
- type: 'null'
title: File Url
description: Url of a file to be transcribed
default: null
file_id:
anyOf:
- type: string
- type: 'null'
title: File Id
description: ID of a file uploaded to /v1/files
default: null
language:
anyOf:
- type: string
pattern: ^\w{2}$
- type: 'null'
title: Language
description: Language of the audio, e.g. 'en'. Providing the language can boost accuracy.
default: null
temperature:
anyOf:
- type: number
- type: 'null'
title: Temperature
default: null
stream:
type: boolean
title: Stream
default: true
const: true
diarize:
type: boolean
title: Diarize
default: false
context_bias:
type: array
items:
type: string
pattern: ^[^,\s]+$
title: Context Bias
default: []
timestamp_granularities:
type: array
items:
$ref: '#/components/schemas/TimestampGranularity'
title: Timestamp Granularities
description: Granularities of timestamps to include in the response.
$defs:
TimestampGranularity:
type: string
title: TimestampGranularity
enum:
- segment
- word
title: AudioTranscriptionRequestStream
required:
- model
TranscriptionStreamLanguage:
type: object
properties:
type:
type: string
title: Type
default: transcription.language
const: transcription.language
audio_language:
type: string
title: Audio Language
pattern: ^\w{2}$
title: TranscriptionStreamLanguage
required:
- audio_language
additionalProperties: false
TranscriptionStreamSegmentDelta:
type: object
properties:
type:
type: string
title: Type
default: transcription.segment
const: transcription.segment
text:
type: string
title: Text
start:
type: number
title: Start
end:
type: number
title: End
speaker_id:
anyOf:
- type: string
- type: 'null'
title: Speaker Id
default: null
title: TranscriptionStreamSegmentDelta
required:
- text
- start
- end
additionalProperties: false
TranscriptionStreamTextDelta:
type: object
properties:
type:
type: string
title: Type
default: transcription.text.delta
const: transcription.text.delta
text:
type: string
title: Text
title: TranscriptionStreamTextDelta
required:
- text
additionalProperties: false
TranscriptionStreamDone:
type: object
properties:
model:
type: string
title: Model
text:
type: string
title: Text
language:
anyOf:
- type: string
pattern: ^\w{2}$
- type: 'null'
title: Language
segments:
type: array
items:
$ref: '#/components/schemas/TranscriptionSegmentChunk'
title: Segments
usage:
$ref: '#/components/schemas/UsageInfo'
type:
type: string
title: Type
default: transcription.done
const: transcription.done
title: TranscriptionStreamDone
required:
- model
- text
- language
- usage
additionalProperties: false
TranscriptionStreamEvents:
type: object
properties:
event:
$ref: '#/components/schemas/TranscriptionStreamEventTypes'
data:
oneOf:
- $ref: '#/components/schemas/TranscriptionStreamTextDelta'
- $ref: '#/components/schemas/TranscriptionStreamLanguage'
- $ref: '#/components/schemas/TranscriptionStreamSegmentDelta'
- $ref: '#/components/schemas/TranscriptionStreamDone'
discriminator:
propertyName: type
mapping:
transcription.done: '#/components/schemas/TranscriptionStreamDone'
transcription.language: '#/components/schemas/TranscriptionStreamLanguage'
transcription.segment: '#/components/schemas/TranscriptionStreamSegmentDelta'
transcription.text.delta: '#/components/schemas/TranscriptionStreamTextDelta'
title: Data
title: TranscriptionStreamEvents
required:
- event
- data
additionalProperties: false
TranscriptionStreamEventTypes:
type: string
title: TranscriptionStreamEventTypes
enum:
- transcription.language
- transcription.segment
- transcription.text.delta
- transcription.done
RealtimeTranscriptionClientMessage:
oneOf:
- $ref: '#/components/schemas/RealtimeTranscriptionSessionUpdateMessage'
- $ref: '#/components/schemas/RealtimeTranscriptionInputAudioAppend'
- $ref: '#/components/schemas/RealtimeTranscriptionInputAudioFlush'
- $ref: '#/components/schemas/RealtimeTranscriptionInputAudioEnd'
discriminator:
propertyName: type
mapping:
input_audio.append: '#/components/schemas/RealtimeTranscriptionInputAudioAppend'
input_audio.end: '#/components/schemas/RealtimeTranscriptionInputAudioEnd'
input_audio.flush: '#/components/schemas/RealtimeTranscriptionInputAudioFlush'
session.update: '#/components/schemas/RealtimeTranscriptionSessionUpdateMessage'
title: RealtimeTranscriptionClientMessage
AudioEncoding:
type: string
title: AudioEncoding
enum:
- pcm_s16le
- pcm_s32le
- pcm_f16le
- pcm_f32le
- pcm_mulaw
- pcm_alaw
AudioFormat:
type: object
properties:
encoding:
$ref: '#/components/schemas/AudioEncoding'
sample_rate:
type: integer
title: Sample Rate
maximum: 96000
minimum: 8000
title: AudioFormat
required:
- encoding
- sample_rate
additionalProperties: false
RealtimeTranscriptionInputAudioAppend:
type: object
properties:
type:
type: string
title: Type
default: input_audio.append
const: input_audio.append
audio:
type: string
title: Audio
format: base64
description: 'Base64-encoded raw PCM bytes matching the current audio_format. Max decoded size: 262144 bytes.'
title: RealtimeTranscriptionInputAudioAppend
required:
- audio
additionalProperties: false
RealtimeTranscriptionInputAudioEnd:
type: object
properties:
type:
type: string
title: Type
default: input_audio.end
const: input_audio.end
title: RealtimeTranscriptionInputAudioEnd
additionalProperties: false
RealtimeTranscriptionInputAudioFlush:
type: object
properties:
type:
type: string
title: Type
default: input_audio.flush
const: input_audio.flush
title: RealtimeTranscriptionInputAudioFlush
additionalProperties: false
RealtimeTranscriptionSessionUpdateMessage:
type: object
properties:
type:
type: string
title: Type
default: session.update
const: session.update
session:
$ref: '#/components/schemas/RealtimeTranscriptionSessionUpdatePayload'
title: RealtimeTranscriptionSessionUpdateMessage
required:
- session
additionalProperties: false
RealtimeTranscriptionSessionUpdatePayload:
type: object
properties:
audio_format:
anyOf:
- $ref: '#/components/schemas/AudioFormat'
- type: 'null'
description: Set before sending audio. Audio format updates are rejected after audio starts.
default: null
target_streaming_delay_ms:
anyOf:
- type: integer
- type: 'null'
title: Target Streaming Delay Ms
description: Set before sending audio. Streaming delay updates are rejected after audio starts.
default: null
title: RealtimeTranscriptionSessionUpdatePayload
additionalProperties: false
AgentsCompletionRequest:
type: object
properties:
max_tokens:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Max Tokens
description: The maximum number of tokens to generate in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length.
stream:
type: boolean
title: Stream
description: 'Whether to stream back partial progress. If set, tokens will be sent as data-only server-side events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.'
default: false
stop:
anyOf:
- type: string
- type: array
items:
type: string
title: Stop
description: Stop generation if this token is detected. Or if one of these tokens is detected when providing an array
random_seed:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Random Seed
description: The seed to use for random sampling. If set, different calls will generate deterministic results.
metadata:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Metadata
messages:
type: array
examples:
- - role: user
content: Who is the best French painter? Answer in one short sentence.
items:
oneOf:
- $ref: '#/components/schemas/SystemMessage'
- $ref: '#/components/schemas/UserMessage'
- $ref: '#/components/schemas/AssistantMessage'
- $ref: '#/components/schemas/ToolMessage'
discriminator:
propertyName: role
mapping:
assistant: '#/components/schemas/AssistantMessage'
system: '#/components/schemas/SystemMessage'
tool: '#/components/schemas/ToolMessage'
user: '#/components/schemas/UserMessage'
title: Messages
description: The prompt(s) to generate completions for, encoded as a list of dict with role and content.
response_format:
$ref: '#/components/schemas/ResponseFormat'
tools:
anyOf:
- type: array
items:
$ref: '#/components/schemas/Tool'
- type: 'null'
title: Tools
tool_choice:
anyOf:
- $ref: '#/components/schemas/ToolChoice'
- $ref: '#/components/schemas/ToolChoiceEnum'
title: Tool Choice
default: auto
presence_penalty:
type: number
title: Presence Penalty
maximum: 2
minimum: -2
description: The `presence_penalty` determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative.
default: 0.0
frequency_penalty:
type: number
title: Frequency Penalty
maximum: 2
minimum: -2
description: The `frequency_penalty` penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition.
default: 0.0
n:
anyOf:
- type: integer
minimum: 1
- type: 'null'
title: N
description: Number of completions to return for each request, input tokens are only billed once.
prediction:
$ref: '#/components/schemas/Prediction'
description: Enable users to specify expected results, optimizing response times by leveraging known or predictable content. This approach is especially effective for updating text documents or code files with minimal changes, reducing latency while maintaining high-quality results.
default:
type: content
content: ''
parallel_tool_calls:
type: boolean
title: Parallel Tool Calls
default: true
prompt_mode:
anyOf:
- $ref: '#/components/schemas/MistralPromptMode'
- type: 'null'
description: Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used. **Deprecated for reasoning models - use `reasoning_effort` parameter instead.**
reasoning_effort:
type: string
enum:
- high
- none
description: Controls the reasoning effort level for reasoning models. "high" enables comprehensive reasoning traces, "none" disables reasoning effort.
prompt_cache_key:
anyOf:
- type: string
- type: 'null'
title: Prompt Cache Key
description: A cache key to enable prompt caching. When provided, the API will attempt to reuse previously computed tokens for requests sharing the same prefix (e.g. multi-turn conversations or requests with a similar system prompt). Cached tokens are billed at 10% of the standard input token price.
agent_id:
type: string
description: The ID of the agent to use for this completion.
title: AgentsCompletionRequest
required:
- messages
- agent_id
additionalProperties: false
ChatClassificationRequest:
type: object
properties:
model:
type: string
title: Model
input:
$ref: '#/components/schemas/ChatClassificationRequestInputs'
title: ChatClassificationRequest
required:
- input
- model
additionalProperties: false
ChatClassificationRequestInputs:
anyOf:
- $ref: '#/components/schemas/InstructRequest'
- type: array
items:
$ref: '#/components/schemas/InstructRequest'
title: ChatClassificationRequestInputs
description: Chat to classify
ClassificationResponse:
type: object
properties:
id:
type: string
example: mod-e5cc70bb28c444948073e77776eb30ef
model:
type: string
results:
type: array
items:
type: object
title: ClassificationTargetResult
additionalProperties:
$ref: '#/components/schemas/ClassificationTargetResult'
title: ClassificationResponse
required:
- id
- model
- results
ClassificationTargetResult:
type: object
properties:
scores:
type: object
title: ClassifierTargetResultScores
additionalProperties:
type: number
title: ClassificationTargetResult
required:
- scores
ContentChunk:
oneOf:
- $ref: '#/components/schemas/TextChunk'
- $ref: '#/components/schemas/ImageURLChunk'
- $ref: '#/components/schemas/DocumentURLChunk'
- $ref: '#/components/schemas/ReferenceChunk'
- $ref: '#/components/schemas/FileChunk'
- $ref: '#/components/schemas/ThinkChunk'
- $ref: '#/components/schemas/AudioChunk'
discriminator:
propertyName: type
mapping:
image_url: '#/components/schemas/ImageURLChunk'
document_url: '#/components/schemas/DocumentURLChunk'
text: '#/components/schemas/TextChunk'
reference: '#/components/schemas/ReferenceChunk'
file: '#/components/schemas/FileChunk'
thinking: '#/components/schemas/ThinkChunk'
input_audio: '#/components/schemas/AudioChunk'
title: ContentChunk
ModerationResponse:
type: object
properties:
id:
type: string
example: mod-e5cc70bb28c444948073e77776eb30ef
model:
type: string
results:
type: array
items:
$ref: '#/components/schemas/ModerationObject'
title: ModerationResponse
required:
- id
- model
- results
ModerationObject:
type: object
properties:
categories:
type: object
additionalProperties:
type: boolean
description: Moderation result thresholds
category_scores:
type: object
additionalProperties:
type: number
description: Moderation result
title: ModerationObject
SystemMessageContentChunks:
oneOf:
- $ref: '#/components/schemas/TextChunk'
- $ref: '#/components/schemas/ThinkChunk'
discriminator:
propertyName: type
mapping:
text: '#/components/schemas/TextChunk'
thinking: '#/components/schemas/ThinkChunk'
title: SystemMessageContentChunks
DocumentOut:
type: object
properties:
id:
type: string
title: Id
format: uuid
library_id:
type: string
title: Library Id
format: uuid
hash:
anyOf:
- type: string
- type: 'null'
title: Hash
mime_type:
anyOf:
- type: string
- type: 'null'
title: Mime Type
extension:
anyOf:
- type: string
- type: 'null'
title: Extension
size:
anyOf:
- type: integer
- type: 'null'
title: Size
name:
type: string
title: Name
summary:
anyOf:
- type: string
- type: 'null'
title: Summary
created_at:
type: string
title: Created At
format: date-time
last_processed_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Processed At
number_of_pages:
anyOf:
- type: integer
- type: 'null'
title: Number Of Pages
process_status:
$ref: '#/components/schemas/ProcessStatus'
uploaded_by_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Uploaded By Id
uploaded_by_type:
type: string
tokens_processing_main_content:
anyOf:
- type: integer
- type: 'null'
title: Tokens Processing Main Content
tokens_processing_summary:
anyOf:
- type: integer
- type: 'null'
title: Tokens Processing Summary
url:
anyOf:
- type: string
- type: 'null'
title: Url
attributes:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Attributes
processing_status:
type: string
title: Processing Status
readOnly: true
tokens_processing_total:
type: integer
title: Tokens Processing Total
readOnly: true
title: DocumentOut
required:
- id
- library_id
- hash
- mime_type
- extension
- size
- name
- created_at
- process_status
- uploaded_by_id
- uploaded_by_type
- processing_status
- tokens_processing_total
DocumentTextContent:
type: object
properties:
text:
type: string
title: Text
title: DocumentTextContent
required:
- text
DocumentUpdateIn:
type: object
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
attributes:
anyOf:
- type: object
additionalProperties:
anyOf:
- type: boolean
- type: string
- type: integer
- type: number
- type: string
format: date-time
- type: array
items:
type: string
- type: array
items:
type: integer
- type: array
items:
type: number
- type: array
items:
type: boolean
- type: 'null'
title: Attributes
title: DocumentUpdateIn
FilterCondition:
type: object
properties:
field:
type: string
title: Field
op:
type: string
title: Op
enum:
- lt
- lte
- gt
- gte
- startswith
- istartswith
- endswith
- iendswith
- contains
- icontains
- matches
- notcontains
- inotcontains
- eq
- neq
- isnull
- includes
- excludes
- len_eq
value:
title: Value
title: FilterCondition
required:
- field
- op
- value
FilterGroup:
type: object
properties:
AND:
anyOf:
- type: array
items:
anyOf:
- $ref: '#/components/schemas/FilterGroup'
- $ref: '#/components/schemas/FilterCondition'
- type: 'null'
title: And
OR:
anyOf:
- type: array
items:
anyOf:
- $ref: '#/components/schemas/FilterGroup'
- $ref: '#/components/schemas/FilterCondition'
- type: 'null'
title: Or
title: FilterGroup
LibraryIn:
type: object
properties:
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
chunk_size:
anyOf:
- type: integer
- type: 'null'
title: Chunk Size
title: LibraryIn
required:
- name
LibraryInUpdate:
type: object
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
title: LibraryInUpdate
LibraryOut:
type: object
properties:
id:
type: string
title: Id
format: uuid
name:
type: string
title: Name
created_at:
type: string
title: Created At
format: date-time
updated_at:
type: string
title: Updated At
format: date-time
owner_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Owner Id
owner_type:
type: string
total_size:
type: integer
title: Total Size
nb_documents:
type: integer
title: Nb Documents
chunk_size:
anyOf:
- type: integer
- type: 'null'
title: Chunk Size
emoji:
anyOf:
- type: string
- type: 'null'
title: Emoji
description:
anyOf:
- type: string
- type: 'null'
title: Description
generated_description:
anyOf:
- type: string
- type: 'null'
title: Generated Description
explicit_user_members_count:
anyOf:
- type: integer
- type: 'null'
title: Explicit User Members Count
explicit_workspace_members_count:
anyOf:
- type: integer
- type: 'null'
title: Explicit Workspace Members Count
org_sharing_role:
anyOf:
- type: string
- type: 'null'
generated_name:
anyOf:
- type: string
- type: 'null'
description: Generated Name
title: LibraryOut
required:
- id
- name
- created_at
- updated_at
- owner_id
- owner_type
- total_size
- nb_documents
- chunk_size
ListDocumentOut:
type: object
properties:
pagination:
$ref: '#/components/schemas/PaginationInfo'
data:
type: array
items:
$ref: '#/components/schemas/DocumentOut'
title: Data
title: ListDocumentOut
required:
- pagination
- data
ListLibraryOut:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/LibraryOut'
title: Data
title: ListLibraryOut
required:
- data
ListSharingOut:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SharingOut'
title: Data
title: ListSharingOut
required:
- data
PaginationInfo:
type: object
properties:
total_items:
type: integer
title: Total Items
total_pages:
type: integer
title: Total Pages
current_page:
type: integer
title: Current Page
page_size:
type: integer
title: Page Size
has_more:
type: boolean
title: Has More
title: PaginationInfo
required:
- total_items
- total_pages
- current_page
- page_size
- has_more
ProcessStatus:
type: string
title: ProcessStatus
enum:
- self_managed
- missing_content
- noop
- done
- todo
- in_progress
- error
- waiting_for_capacity
ProcessingStatusOut:
type: object
properties:
document_id:
type: string
title: Document Id
format: uuid
process_status:
$ref: '#/components/schemas/ProcessStatus'
processing_status:
type: string
title: Processing Status
readOnly: true
title: ProcessingStatusOut
required:
- document_id
- process_status
- processing_status
ShareEnum:
type: string
title: ShareEnum
enum:
- Viewer
- Editor
x-speakeasy-unknown-values: allow
SharingDelete:
type: object
properties:
org_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Org Id
share_with_uuid:
type: string
format: uuid
description: The id of the entity (user, workspace or organization) to share with
share_with_type:
$ref: '#/components/schemas/EntityType'
title: SharingDelete
required:
- share_with_uuid
- share_with_type
- level
SharingIn:
type: object
properties:
org_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Org Id
level:
$ref: '#/components/schemas/ShareEnum'
share_with_uuid:
type: string
format: uuid
description: The id of the entity (user, workspace or organization) to share with
share_with_type:
$ref: '#/components/schemas/EntityType'
title: SharingIn
required:
- share_with_uuid
- share_with_type
- level
SharingOut:
type: object
properties:
library_id:
type: string
title: Library Id
format: uuid
user_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: User Id
org_id:
type: string
title: Org Id
format: uuid
role:
type: string
share_with_type:
type: string
share_with_uuid:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Share With Uuid
title: SharingOut
required:
- library_id
- org_id
- role
- share_with_type
- share_with_uuid
EntityType:
type: string
title: EntityType
enum:
- User
- Workspace
- Org
description: The type of entity, used to share a library.
x-speakeasy-unknown-values: allow
BaseFieldDefinition:
type: object
properties:
name:
type: string
title: Name
label:
type: string
title: Label
type:
type: string
title: Type
enum:
- ENUM
- TEXT
- INT
- FLOAT
- BOOL
- TIMESTAMP
- ARRAY
group:
anyOf:
- type: string
- type: 'null'
title: Group
supported_operators:
type: array
items:
type: string
enum:
- lt
- lte
- gt
- gte
- startswith
- istartswith
- endswith
- iendswith
- contains
- icontains
- matches
- notcontains
- inotcontains
- eq
- neq
- isnull
- includes
- excludes
- len_eq
title: Supported Operators
readOnly: true
title: BaseFieldDefinition
required:
- name
- label
- type
- supported_operators
BaseTaskStatus:
type: string
title: BaseTaskStatus
enum:
- RUNNING
- COMPLETED
- FAILED
- CANCELED
- TERMINATED
- CONTINUED_AS_NEW
- TIMED_OUT
- UNKNOWN
CampaignPreview:
type: object
properties:
id:
type: string
title: Id
format: uuid
created_at:
type: string
title: Created At
format: date-time
updated_at:
type: string
title: Updated At
format: date-time
deleted_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Deleted At
name:
type: string
title: Name
owner_id:
type: string
title: Owner Id
format: uuid
workspace_id:
type: string
title: Workspace Id
format: uuid
description:
type: string
title: Description
max_nb_events:
type: integer
title: Max Nb Events
search_params:
$ref: '#/components/schemas/FilterPayload'
judge:
$ref: '#/components/schemas/JudgePreview'
title: CampaignPreview
required:
- id
- created_at
- updated_at
- deleted_at
- name
- owner_id
- workspace_id
- description
- max_nb_events
- search_params
- judge
CampaignPreviews:
type: object
properties:
campaigns:
$ref: '#/components/schemas/PaginatedResult_CampaignPreview_'
title: CampaignPreviews
required:
- campaigns
CampaignSelectedEvents:
type: object
properties:
completion_events:
$ref: '#/components/schemas/PaginatedResult_ChatCompletionEventPreview_'
title: CampaignSelectedEvents
required:
- completion_events
CampaignStatus:
type: object
properties:
status:
$ref: '#/components/schemas/BaseTaskStatus'
title: CampaignStatus
required:
- status
ChatCompletionEventIds:
type: object
properties:
completion_event_ids:
type: array
items:
type: string
title: Completion Event Ids
title: ChatCompletionEventIds
required:
- completion_event_ids
ChatCompletionEvent:
type: object
properties:
event_id:
type: string
title: Event Id
correlation_id:
type: string
title: Correlation Id
created_at:
type: string
title: Created At
format: date-time
extra_fields:
type: object
title: Extra Fields
additionalProperties:
anyOf:
- type: boolean
- type: integer
- type: number
- type: string
- type: string
format: date-time
- type: array
items:
type: string
- type: 'null'
nb_input_tokens:
type: integer
title: Nb Input Tokens
nb_output_tokens:
type: integer
title: Nb Output Tokens
enabled_tools:
type: array
items:
type: object
additionalProperties: true
title: Enabled Tools
request_messages:
type: array
items:
type: object
additionalProperties: true
title: Request Messages
response_messages:
type: array
items:
type: object
additionalProperties: true
title: Response Messages
nb_messages:
type: integer
title: Nb Messages
chat_transcription_events:
type: array
items:
$ref: '#/components/schemas/ChatTranscriptionEvent'
title: Chat Transcription Events
title: ChatCompletionEvent
required:
- event_id
- correlation_id
- created_at
- extra_fields
- nb_input_tokens
- nb_output_tokens
- enabled_tools
- request_messages
- response_messages
- nb_messages
- chat_transcription_events
ChatCompletionEventPreview:
type: object
properties:
event_id:
type: string
title: Event Id
correlation_id:
type: string
title: Correlation Id
created_at:
type: string
title: Created At
format: date-time
extra_fields:
type: object
title: Extra Fields
additionalProperties:
anyOf:
- type: boolean
- type: integer
- type: number
- type: string
- type: string
format: date-time
- type: array
items:
type: string
- type: 'null'
nb_input_tokens:
type: integer
title: Nb Input Tokens
nb_output_tokens:
type: integer
title: Nb Output Tokens
title: ChatCompletionEventPreview
required:
- event_id
- correlation_id
- created_at
- extra_fields
- nb_input_tokens
- nb_output_tokens
ChatCompletionEvents:
type: object
properties:
completion_events:
$ref: '#/components/schemas/FeedResult_ChatCompletionEventPreview_'
title: ChatCompletionEvents
required:
- completion_events
ChatCompletionFieldOptions:
type: object
properties:
options:
anyOf:
- type: array
items:
anyOf:
- type: string
- type: boolean
- type: 'null'
- type: 'null'
title: Options
title: ChatCompletionFieldOptions
ChatCompletionFields:
type: object
properties:
field_definitions:
type: array
items:
$ref: '#/components/schemas/BaseFieldDefinition'
title: Field Definitions
field_groups:
type: array
items:
$ref: '#/components/schemas/FieldGroup'
title: Field Groups
title: ChatCompletionFields
required:
- field_definitions
- field_groups
ChatTranscriptionEvent:
type: object
properties:
audio_url:
type: string
title: Audio Url
model:
type: string
title: Model
response_message:
type: object
title: Response Message
additionalProperties: true
title: ChatTranscriptionEvent
required:
- audio_url
- model
- response_message
ConversationPayload:
type: object
properties:
messages:
type: array
items:
type: object
additionalProperties: true
title: Messages
title: ConversationPayload
required:
- messages
additionalProperties: true
description: ''
ConversationSource:
type: string
title: ConversationSource
enum:
- EXPLORER
- UPLOADED_FILE
- DIRECT_INPUT
- PLAYGROUND
DatasetExport:
type: object
properties:
file_url:
type: string
title: File Url
title: DatasetExport
required:
- file_url
DatasetImportTask:
type: object
properties:
id:
type: string
title: Id
format: uuid
created_at:
type: string
title: Created At
format: date-time
updated_at:
type: string
title: Updated At
format: date-time
deleted_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Deleted At
creator_id:
type: string
title: Creator Id
format: uuid
dataset_id:
type: string
title: Dataset Id
format: uuid
workspace_id:
type: string
title: Workspace Id
format: uuid
status:
$ref: '#/components/schemas/BaseTaskStatus'
progress:
anyOf:
- type: integer
maximum: 100
minimum: 0
- type: 'null'
title: Progress
message:
anyOf:
- type: string
- type: 'null'
title: Message
title: DatasetImportTask
required:
- id
- created_at
- updated_at
- deleted_at
- creator_id
- dataset_id
- workspace_id
- status
DatasetImportTasks:
type: object
properties:
tasks:
$ref: '#/components/schemas/PaginatedResult_DatasetImportTask_'
title: DatasetImportTasks
required:
- tasks
Dataset:
type: object
properties:
id:
type: string
title: Id
format: uuid
created_at:
type: string
title: Created At
format: date-time
updated_at:
type: string
title: Updated At
format: date-time
deleted_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Deleted At
name:
type: string
title: Name
description:
type: string
title: Description
owner_id:
type: string
title: Owner Id
format: uuid
workspace_id:
type: string
title: Workspace Id
format: uuid
title: Dataset
required:
- id
- created_at
- updated_at
- deleted_at
- name
- description
- owner_id
- workspace_id
DatasetPreview:
type: object
properties:
id:
type: string
title: Id
format: uuid
created_at:
type: string
title: Created At
format: date-time
updated_at:
type: string
title: Updated At
format: date-time
deleted_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Deleted At
name:
type: string
title: Name
description:
type: string
title: Description
owner_id:
type: string
title: Owner Id
format: uuid
workspace_id:
type: string
title: Workspace Id
format: uuid
title: DatasetPreview
required:
- id
- created_at
- updated_at
- deleted_at
- name
- description
- owner_id
- workspace_id
DatasetPreviews:
type: object
properties:
datasets:
$ref: '#/components/schemas/PaginatedResult_DatasetPreview_'
title: DatasetPreviews
required:
- datasets
DatasetRecord:
type: object
properties:
id:
type: string
title: Id
format: uuid
created_at:
type: string
title: Created At
format: date-time
updated_at:
type: string
title: Updated At
format: date-time
deleted_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Deleted At
dataset_id:
type: string
title: Dataset Id
format: uuid
payload:
$ref: '#/components/schemas/ConversationPayload'
properties:
type: object
title: Properties
additionalProperties: true
source:
$ref: '#/components/schemas/ConversationSource'
title: DatasetRecord
required:
- id
- created_at
- updated_at
- deleted_at
- dataset_id
- payload
- properties
- source
DatasetRecords:
type: object
properties:
records:
$ref: '#/components/schemas/PaginatedResult_DatasetRecord_'
title: DatasetRecords
required:
- records
DeleteDatasetRecordsInSchema:
type: object
properties:
dataset_record_ids:
type: array
items:
type: string
format: uuid
title: Dataset Record Ids
maxItems: 500
minItems: 1
title: DeleteDatasetRecordsInSchema
required:
- dataset_record_ids
FeedResult_ChatCompletionEventPreview_:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/ChatCompletionEventPreview'
title: Results
next:
anyOf:
- type: string
- type: 'null'
title: Next
cursor:
anyOf:
- type: string
- type: 'null'
title: Cursor
title: FeedResult[ChatCompletionEventPreview]
FieldGroup:
type: object
properties:
name:
type: string
title: Name
label:
type: string
title: Label
title: FieldGroup
required:
- name
- label
FieldOptionCountItem:
type: object
properties:
value:
type: string
title: Value
count:
type: integer
title: Count
title: FieldOptionCountItem
required:
- value
- count
FieldOptionCountsInSchema:
type: object
properties:
filter_params:
anyOf:
- $ref: '#/components/schemas/FilterPayload'
- type: 'null'
title: FieldOptionCountsInSchema
FieldOptionCounts:
type: object
properties:
counts:
type: array
items:
$ref: '#/components/schemas/FieldOptionCountItem'
title: Counts
title: FieldOptionCounts
required:
- counts
FilterPayload:
type: object
properties:
filters:
anyOf:
- $ref: '#/components/schemas/FilterGroup'
- $ref: '#/components/schemas/FilterCondition'
- type: 'null'
title: Filters
title: FilterPayload
required:
- filters
GetChatCompletionEventIdsInSchema:
type: object
properties:
search_params:
$ref: '#/components/schemas/FilterPayload'
extra_fields:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Extra Fields
title: GetChatCompletionEventIdsInSchema
required:
- search_params
GetChatCompletionEventsInSchema:
type: object
properties:
search_params:
$ref: '#/components/schemas/FilterPayload'
extra_fields:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Extra Fields
title: GetChatCompletionEventsInSchema
required:
- search_params
JudgeClassificationOutput:
type: object
properties:
type:
type: string
title: Type
default: CLASSIFICATION
const: CLASSIFICATION
options:
type: array
items:
$ref: '#/components/schemas/JudgeClassificationOutputOption'
title: Options
title: JudgeClassificationOutput
required:
- options
JudgeClassificationOutputOption:
type: object
properties:
value:
type: string
title: Value
description:
type: string
title: Description
title: JudgeClassificationOutputOption
required:
- value
- description
JudgeOutput:
type: object
properties:
analysis:
type: string
title: Analysis
answer:
anyOf:
- type: string
- type: number
title: Answer
title: JudgeOutput
required:
- analysis
- answer
JudgeOutputType:
type: string
title: JudgeOutputType
enum:
- REGRESSION
- CLASSIFICATION
JudgePreview:
type: object
properties:
id:
type: string
title: Id
format: uuid
created_at:
type: string
title: Created At
format: date-time
updated_at:
type: string
title: Updated At
format: date-time
deleted_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Deleted At
owner_id:
type: string
title: Owner Id
format: uuid
workspace_id:
type: string
title: Workspace Id
format: uuid
name:
type: string
title: Name
description:
type: string
title: Description
model_name:
type: string
title: Model Name
output:
oneOf:
- $ref: '#/components/schemas/JudgeClassificationOutput'
- $ref: '#/components/schemas/JudgeRegressionOutput'
discriminator:
propertyName: type
mapping:
CLASSIFICATION: '#/components/schemas/JudgeClassificationOutput'
REGRESSION: '#/components/schemas/JudgeRegressionOutput'
title: Output
instructions:
type: string
title: Instructions
tools:
type: array
items:
type: string
title: Tools
up_revision:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Up Revision
down_revision:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Down Revision
base_revision:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Base Revision
title: JudgePreview
required:
- id
- created_at
- updated_at
- deleted_at
- owner_id
- workspace_id
- name
- description
- model_name
- output
- instructions
- tools
JudgePreviews:
type: object
properties:
judges:
$ref: '#/components/schemas/PaginatedResult_JudgePreview_'
title: JudgePreviews
required:
- judges
JudgeRegressionOutput:
type: object
properties:
type:
type: string
title: Type
default: REGRESSION
const: REGRESSION
min:
type: number
title: Min
minimum: 0
default: 0
min_description:
type: string
title: Min Description
max:
exclusiveMaximum: 1e+09
type: number
title: Max
default: 1
max_description:
type: string
title: Max Description
title: JudgeRegressionOutput
required:
- min_description
- max_description
PaginatedResult_CampaignPreview_:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/CampaignPreview'
title: Results
count:
type: integer
title: Count
next:
anyOf:
- type: string
- type: 'null'
title: Next
previous:
anyOf:
- type: string
- type: 'null'
title: Previous
title: PaginatedResult[CampaignPreview]
required:
- count
PaginatedResult_ChatCompletionEventPreview_:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/ChatCompletionEventPreview'
title: Results
count:
type: integer
title: Count
next:
anyOf:
- type: string
- type: 'null'
title: Next
previous:
anyOf:
- type: string
- type: 'null'
title: Previous
title: PaginatedResult[ChatCompletionEventPreview]
required:
- count
PaginatedResult_DatasetImportTask_:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/DatasetImportTask'
title: Results
count:
type: integer
title: Count
next:
anyOf:
- type: string
- type: 'null'
title: Next
previous:
anyOf:
- type: string
- type: 'null'
title: Previous
title: PaginatedResult[DatasetImportTask]
required:
- count
PaginatedResult_DatasetPreview_:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/DatasetPreview'
title: Results
count:
type: integer
title: Count
next:
anyOf:
- type: string
- type: 'null'
title: Next
previous:
anyOf:
- type: string
- type: 'null'
title: Previous
title: PaginatedResult[DatasetPreview]
required:
- count
PaginatedResult_DatasetRecord_:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/DatasetRecord'
title: Results
count:
type: integer
title: Count
next:
anyOf:
- type: string
- type: 'null'
title: Next
previous:
anyOf:
- type: string
- type: 'null'
title: Previous
title: PaginatedResult[DatasetRecord]
required:
- count
PaginatedResult_JudgePreview_:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/JudgePreview'
title: Results
count:
type: integer
title: Count
next:
anyOf:
- type: string
- type: 'null'
title: Next
previous:
anyOf:
- type: string
- type: 'null'
title: Previous
title: PaginatedResult[JudgePreview]
required:
- count
PatchDatasetInSchema:
type: object
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
title: PatchDatasetInSchema
PostCampaignInSchema:
type: object
properties:
search_params:
$ref: '#/components/schemas/FilterPayload'
judge_id:
type: string
title: Judge Id
format: uuid
name:
type: string
title: Name
maxLength: 50
minLength: 5
description:
type: string
title: Description
max_nb_events:
exclusiveMinimum: 0
type: integer
title: Max Nb Events
maximum: 10000
title: PostCampaignInSchema
required:
- search_params
- judge_id
- name
- description
- max_nb_events
PostChatCompletionEventJudgingInSchema:
type: object
properties:
judge_definition:
$ref: '#/components/schemas/PostJudgeInSchema'
title: PostChatCompletionEventJudgingInSchema
required:
- judge_definition
PostDatasetImportFromCampaignInSchema:
type: object
properties:
campaign_id:
type: string
title: Campaign Id
format: uuid
title: PostDatasetImportFromCampaignInSchema
required:
- campaign_id
PostDatasetImportFromDatasetInSchema:
type: object
properties:
dataset_record_ids:
type: array
items:
type: string
format: uuid
title: Dataset Record Ids
maxItems: 10000
minItems: 1
title: PostDatasetImportFromDatasetInSchema
required:
- dataset_record_ids
PostDatasetImportFromExplorerInSchema:
type: object
properties:
completion_event_ids:
type: array
items:
type: string
title: Completion Event Ids
maxItems: 500
title: PostDatasetImportFromExplorerInSchema
required:
- completion_event_ids
PostDatasetImportFromFileInSchema:
type: object
properties:
file_id:
type: string
title: File Id
title: PostDatasetImportFromFileInSchema
required:
- file_id
PostDatasetImportFromPlaygroundInSchema:
type: object
properties:
conversation_ids:
type: array
items:
type: string
title: Conversation Ids
title: PostDatasetImportFromPlaygroundInSchema
required:
- conversation_ids
PostDatasetInSchema:
type: object
properties:
name:
type: string
title: Name
maxLength: 50
minLength: 5
description:
type: string
title: Description
maxLength: 200
title: PostDatasetInSchema
required:
- name
- description
PostDatasetRecordInSchema:
type: object
properties:
payload:
$ref: '#/components/schemas/ConversationPayload'
properties:
type: object
title: Properties
additionalProperties: true
title: PostDatasetRecordInSchema
required:
- payload
- properties
PostDatasetRecordJudgingInSchema:
type: object
properties:
judge_definition:
$ref: '#/components/schemas/PostJudgeInSchema'
title: PostDatasetRecordJudgingInSchema
required:
- judge_definition
PostJudgeInSchema:
type: object
properties:
name:
type: string
title: Name
maxLength: 50
minLength: 5
description:
type: string
title: Description
maxLength: 500
model_name:
type: string
title: Model Name
maxLength: 500
output:
oneOf:
- $ref: '#/components/schemas/JudgeClassificationOutput'
- $ref: '#/components/schemas/JudgeRegressionOutput'
discriminator:
propertyName: type
mapping:
CLASSIFICATION: '#/components/schemas/JudgeClassificationOutput'
REGRESSION: '#/components/schemas/JudgeRegressionOutput'
title: Output
instructions:
type: string
title: Instructions
maxLength: 10000
tools:
type: array
items:
type: string
title: Tools
title: PostJudgeInSchema
required:
- name
- description
- model_name
- output
- instructions
- tools
PutDatasetRecordPayloadInSchema:
type: object
properties:
payload:
$ref: '#/components/schemas/ConversationPayload'
title: PutDatasetRecordPayloadInSchema
required:
- payload
PutDatasetRecordPropertiesInSchema:
type: object
properties:
properties:
type: object
title: Properties
additionalProperties: true
title: PutDatasetRecordPropertiesInSchema
required:
- properties
PutJudgeInSchema:
type: object
properties:
name:
type: string
title: Name
maxLength: 50
minLength: 5
description:
type: string
title: Description
maxLength: 500
model_name:
type: string
title: Model Name
maxLength: 500
output:
oneOf:
- $ref: '#/components/schemas/JudgeClassificationOutput'
- $ref: '#/components/schemas/JudgeRegressionOutput'
discriminator:
propertyName: type
mapping:
CLASSIFICATION: '#/components/schemas/JudgeClassificationOutput'
REGRESSION: '#/components/schemas/JudgeRegressionOutput'
title: Output
instructions:
type: string
title: Instructions
maxLength: 10000
tools:
type: array
items:
type: string
title: Tools
title: PutJudgeInSchema
required:
- name
- description
- model_name
- output
- instructions
- tools
ObservabilityErrorCode:
type: string
title: ObservabilityErrorCode
enum:
- UNKNOWN_ERROR
- VALIDATION_ERROR
- AUTH_FORBIDDEN
- AUTH_FORBIDDEN_NOT_WORKSPACE_ADMIN
- AUTH_FORBIDDEN_WORKSPACE_NOT_FOUND
- AUTH_FORBIDDEN_ROLE_NOT_FOUND
- AUTH_FORBIDDEN_ORG_NOT_WHITELISTED
- AUTH_UNAUTHORIZED
- FEATURE_NOT_SUPPORTED
- FIELDS_BAD_REQUEST
- FIELDS_NOT_FOUND
- SEARCH_NOT_FOUND
- SEARCH_BAD_REQUEST
- SEARCH_SERVICE_UNAVAILABLE
- DATABASE_ERROR
- DATABASE_TIMEOUT
- DATABASE_UNAVAILABLE
- DATABASE_QUERY_ERROR
- SEARCH_FILTER_TO_SQL_CONVERSION_ERROR
- JUDGE_CONVERSATION_FORMAT_ERROR
- JUDGE_MISTRAL_API_ERROR
- JUDGE_MISTRAL_API_TIMEOUT
- JUDGE_NAME_ALREADY_EXISTS
- JUDGE_NOT_FOUND
- JUDGE_ALREADY_HAS_NEW_VERSION
- JUDGE_USED_IN_CAMPAIGN_CANNOT_BE_UPDATED
- JUDGE_DID_NOT_CHANGE
- CAMPAIGN_NOT_FOUND
- CAMPAIGN_NO_MATCHING_EVENTS
- DATASET_NOT_FOUND
- DATASET_TASK_NOT_FOUND
- DATASET_RECORD_NOT_FOUND
- DATASET_RECORD_FORMAT_ERROR
- AGENT_NOT_FOUND
- AGENT_MISTRAL_API_ERROR
- EVALUATION_NOT_FOUND
- EVALUATION_CURRENTLY_RUNNING
- EVALUATION_RECORD_NOT_FOUND
- EVALUATION_RUN_NOT_FOUND
- EVALUATION_RUN_TRANSITION_IS_INVALID
- EVALUATION_RUN_TRANSITION_IS_RUNNING_ALREADY
- EVALUATION_RUN_TRANSITION_ERROR
- TEMPLATE_SYNTAX_ERROR
ObservabilityErrorDetail:
type: object
properties:
message:
type: string
title: Message
x-speakeasy-error-message: true
error_code:
anyOf:
- $ref: '#/components/schemas/ObservabilityErrorCode'
- type: 'null'
title: ObservabilityErrorDetail
required:
- message
- error_code
ObservabilityError:
type: object
properties:
detail:
$ref: '#/components/schemas/ObservabilityErrorDetail'
title: ObservabilityError
required:
- detail
JudgeConversationRequest:
type: object
properties:
messages:
type: array
items:
type: object
additionalProperties: true
title: Messages
properties:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Properties
title: JudgeConversationRequest
required:
- messages
Annotations:
type: object
properties:
audience:
anyOf:
- type: array
items:
type: string
enum:
- user
- assistant
- type: 'null'
title: Audience
priority:
anyOf:
- type: number
maximum: 1
minimum: 0
- type: 'null'
title: Priority
title: Annotations
additionalProperties: true
AudioContent:
type: object
properties:
type:
type: string
title: Type
const: audio
data:
type: string
title: Data
mimeType:
type: string
title: Mimetype
annotations:
anyOf:
- $ref: '#/components/schemas/Annotations'
- type: 'null'
_meta:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Meta
title: AudioContent
required:
- type
- data
- mimeType
additionalProperties: true
description: Audio content for a message.
AuthData:
type: object
properties:
client_id:
type: string
title: Client Id
client_secret:
type: string
title: Client Secret
title: AuthData
required:
- client_id
- client_secret
BlobResourceContents:
type: object
properties:
uri:
type: string
title: Uri
minLength: 1
format: uri
mimeType:
anyOf:
- type: string
- type: 'null'
title: Mimetype
_meta:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Meta
blob:
type: string
title: Blob
title: BlobResourceContents
required:
- uri
- blob
additionalProperties: true
description: Binary contents of a resource.
Connector:
type: object
properties:
id:
type: string
title: Id
format: uuid
name:
type: string
title: Name
description:
type: string
title: Description
created_at:
type: string
title: Created At
format: date-time
modified_at:
type: string
title: Modified At
format: date-time
server:
anyOf:
- type: string
- type: 'null'
title: Server
auth_type:
anyOf:
- type: string
- type: 'null'
title: Auth Type
tools:
anyOf:
- type: array
items:
$ref: '#/components/schemas/integrations__schemas__api__tool__Tool'
- type: 'null'
title: Tools
title: Connector
required:
- id
- name
- description
- created_at
- modified_at
ConnectorMCPCreate:
type: object
properties:
name:
type: string
title: Name
description: The name of the connector. Should be 64 char length maximum, alphanumeric, only underscores/dashes.
description:
type: string
title: Description
description: The description of the connector.
icon_url:
anyOf:
- type: string
- type: 'null'
title: Icon Url
description: The optional url of the icon you want to associate to the connector.
visibility:
$ref: '#/components/schemas/ResourceVisibility'
description: Visibility of the connector. Use 'shared_workspace' for workspace scoped connectors, or 'private' for private connectors.
default: shared_org
server:
type: string
title: Server
maxLength: 2083
minLength: 1
format: uri
description: The url of the MCP server.
headers:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Headers
description: Optional organization-level headers to be sent with the request to the mcp server.
auth_data:
anyOf:
- $ref: '#/components/schemas/AuthData'
- type: 'null'
description: Optional additional authentication data for the connector.
system_prompt:
anyOf:
- type: string
- type: 'null'
title: System Prompt
description: Optional system prompt for the connector.
title: ConnectorMCPCreate
required:
- name
- description
- server
ConnectorMCPUpdate:
type: object
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: The name of the connector.
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: The description of the connector.
icon_url:
anyOf:
- type: string
- type: 'null'
title: Icon Url
description: The optional url of the icon you want to associate to the connector.
system_prompt:
anyOf:
- type: string
- type: 'null'
title: System Prompt
description: Optional system prompt for the connector.
connection_config:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Connection Config
description: Optional new connection config.
connection_secrets:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Connection Secrets
description: Optional new connection secrets
server:
anyOf:
- type: string
maxLength: 2083
minLength: 1
format: uri
- type: 'null'
title: Server
description: New server url for your mcp connector.
headers:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Headers
description: New headers for your mcp connector.
auth_data:
anyOf:
- $ref: '#/components/schemas/AuthData'
- type: 'null'
description: New authentication data for your mcp connector.
title: ConnectorMCPUpdate
ConnectorSupportedLanguage:
type: string
title: ConnectorSupportedLanguage
enum:
- en
- fr
- ar
- es
- de
- pl
- pt-BR
- it
- nl
ConnectorsQueryFilters:
type: object
properties:
active:
anyOf:
- type: boolean
- type: 'null'
title: Active
description: Filter for active connectors for a given user, workspace and organization.
fetch_connection_secrets:
type: boolean
title: Fetch Connection Secrets
description: Fetch connection secrets.
default: false
title: ConnectorsQueryFilters
EmbeddedResource:
type: object
properties:
type:
type: string
title: Type
const: resource
resource:
anyOf:
- $ref: '#/components/schemas/TextResourceContents'
- $ref: '#/components/schemas/BlobResourceContents'
title: Resource
annotations:
anyOf:
- $ref: '#/components/schemas/Annotations'
- type: 'null'
_meta:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Meta
title: EmbeddedResource
required:
- type
- resource
additionalProperties: true
description: 'The contents of a resource, embedded into a prompt or tool call result.
It is up to the client how best to render embedded resources for the benefit
of the LLM and/or the user.'
ExecutionConfig:
type: object
properties:
type:
type: string
title: Type
title: ExecutionConfig
required:
- type
additionalProperties: true
description: 'Not typed since mcp config can changed / not stable
we allow all extra fields and this is a dict
TODO: once mcp is stable, we need to type this'
ImageContent:
type: object
properties:
type:
type: string
title: Type
const: image
data:
type: string
title: Data
mimeType:
type: string
title: Mimetype
annotations:
anyOf:
- $ref: '#/components/schemas/Annotations'
- type: 'null'
_meta:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Meta
title: ImageContent
required:
- type
- data
- mimeType
additionalProperties: true
description: Image content for a message.
MCPResultMetadata:
type: object
properties:
isError:
type: boolean
title: Iserror
default: false
structuredContent:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Structuredcontent
_meta:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Meta
title: MCPResultMetadata
additionalProperties: true
description: MCP-specific result metadata (isError, structuredContent, _meta).
MCPToolCallMetadata:
type: object
properties:
mcp_meta:
anyOf:
- $ref: '#/components/schemas/MCPResultMetadata'
- type: 'null'
title: MCPToolCallMetadata
additionalProperties: true
description: 'Metadata wrapper for MCP tool call responses.
Nests MCP-specific fields under `mcp_meta` to avoid collisions with other
metadata keys (e.g. `tool_call_result`) in Harmattan''s streaming deltas.'
MCPToolCallRequest:
type: object
properties:
arguments:
type: object
title: Arguments
additionalProperties: true
title: MCPToolCallRequest
description: Request body for calling an MCP tool.
MCPToolCallResponse:
type: object
properties:
content:
type: array
items:
anyOf:
- $ref: '#/components/schemas/TextContent'
- $ref: '#/components/schemas/ImageContent'
- $ref: '#/components/schemas/AudioContent'
- $ref: '#/components/schemas/ResourceLink'
- $ref: '#/components/schemas/EmbeddedResource'
title: Content
metadata:
anyOf:
- $ref: '#/components/schemas/MCPToolCallMetadata'
- type: 'null'
title: MCPToolCallResponse
required:
- content
additionalProperties: true
description: 'Response from calling an MCP tool.
We override mcp_types.CallToolResult because:
- Models only support `content`, not `structuredContent` at top level
- Downstream consumers (le-chat, etc.) need structuredContent/isError/_meta via metadata
SYNC: Keep in sync with Harmattan (orchestrator) for harmonized tool result processing.'
MessageResponse:
type: object
properties:
message:
type: string
title: Message
title: MessageResponse
required:
- message
PaginationResponse:
type: object
properties:
next_cursor:
anyOf:
- type: string
- type: 'null'
title: Next Cursor
page_size:
type: integer
title: Page Size
title: PaginationResponse
required:
- page_size
ResourceLink:
type: object
properties:
name:
type: string
title: Name
title:
anyOf:
- type: string
- type: 'null'
title: Title
uri:
type: string
title: Uri
minLength: 1
format: uri
description:
anyOf:
- type: string
- type: 'null'
title: Description
mimeType:
anyOf:
- type: string
- type: 'null'
title: Mimetype
size:
anyOf:
- type: integer
- type: 'null'
title: Size
icons:
anyOf:
- type: array
items:
$ref: '#/components/schemas/MCPServerIcon'
- type: 'null'
title: Icons
annotations:
anyOf:
- $ref: '#/components/schemas/Annotations'
- type: 'null'
_meta:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Meta
type:
type: string
title: Type
const: resource_link
title: ResourceLink
required:
- name
- uri
- type
additionalProperties: true
description: 'A resource that the server is capable of reading, included in a prompt or tool call result.
Note: resource links returned by tools are not guaranteed to appear in the results of `resources/list` requests.'
ResourceVisibility:
type: string
title: ResourceVisibility
enum:
- shared_global
- shared_org
- shared_workspace
- private
TextContent:
type: object
properties:
type:
type: string
title: Type
const: text
text:
type: string
title: Text
annotations:
anyOf:
- $ref: '#/components/schemas/Annotations'
- type: 'null'
_meta:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Meta
title: TextContent
required:
- type
- text
additionalProperties: true
description: Text content for a message.
TextResourceContents:
type: object
properties:
uri:
type: string
title: Uri
minLength: 1
format: uri
mimeType:
anyOf:
- type: string
- type: 'null'
title: Mimetype
_meta:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Meta
text:
type: string
title: Text
title: TextResourceContents
required:
- uri
- text
additionalProperties: true
description: Text contents of a resource.
integrations__schemas__api__tool__Tool:
type: object
properties:
id:
type: string
title: Id
name:
type: string
title: Name
description:
type: string
title: Description
system_prompt:
anyOf:
- type: string
- type: 'null'
title: System Prompt
locale:
anyOf:
- $ref: '#/components/schemas/integrations__schemas__turbine__ToolLocale'
- type: 'null'
jsonschema:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Jsonschema
execution_config:
anyOf:
- $ref: '#/components/schemas/ExecutionConfig'
- type: 'null'
visibility:
$ref: '#/components/schemas/ResourceVisibility'
created_at:
type: string
title: Created At
format: date-time
modified_at:
type: string
title: Modified At
format: date-time
active:
anyOf:
- type: boolean
- type: 'null'
title: Active
title: Tool
required:
- id
- name
- description
- execution_config
- visibility
- created_at
- modified_at
integrations__schemas__turbine__ToolLocale:
type: object
properties:
name:
type: object
propertyNames:
$ref: '#/components/schemas/ConnectorSupportedLanguage'
title: Name
additionalProperties:
type: string
description:
type: object
propertyNames:
$ref: '#/components/schemas/ConnectorSupportedLanguage'
title: Description
additionalProperties:
type: string
usage_sentence:
type: object
propertyNames:
$ref: '#/components/schemas/ConnectorSupportedLanguage'
title: Usage Sentence
additionalProperties:
type: string
title: ToolLocale
required:
- name
- description
- usage_sentence
PaginatedConnectors:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Connector'
title: Items
pagination:
$ref: '#/components/schemas/PaginationResponse'
title: PaginatedConnectors
required:
- items
- pagination
MCPServerIcon:
type: object
properties:
src:
type: string
title: Src
mimeType:
anyOf:
- type: string
- type: 'null'
title: Mimetype
sizes:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Sizes
title: MCPServerIcon
required:
- src
additionalProperties: true
description: An icon for display in user interfaces.
CompletionEvent:
title: CompletionEvent
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/CompletionChunk'
CompletionChunk:
title: CompletionChunk
type: object
required:
- id
- model
- choices
properties:
id:
type: string
object:
type: string
created:
type: integer
model:
type: string
usage:
$ref: '#/components/schemas/UsageInfo'
choices:
type: array
items:
$ref: '#/components/schemas/CompletionResponseStreamChoice'
CompletionResponseStreamChoice:
title: CompletionResponseStreamChoice
type: object
required:
- index
- delta
- finish_reason
properties:
index:
type: integer
delta:
$ref: '#/components/schemas/DeltaMessage'
finish_reason:
type:
- string
- 'null'
enum:
- stop
- length
- error
- tool_calls
- null
ResponseBase:
type: object
title: ResponseBase
properties:
id:
type: string
example: cmpl-e5cc70bb28c444948073e77776eb30ef
object:
type: string
example: chat.completion
model:
type: string
example: mistral-small-latest
usage:
$ref: '#/components/schemas/UsageInfo'
ChatCompletionChoice:
title: ChatCompletionChoice
type: object
required:
- index
- finish_reason
- message
properties:
index:
type: integer
example: 0
message:
$ref: '#/components/schemas/AssistantMessage'
finish_reason:
type: string
enum:
- stop
- length
- model_length
- error
- tool_calls
example: stop
DeltaMessage:
title: DeltaMessage
type: object
properties:
role:
anyOf:
- type: string
- type: 'null'
content:
anyOf:
- type: string
- type: 'null'
- items:
$ref: '#/components/schemas/ContentChunk'
type: array
tool_calls:
anyOf:
- type: 'null'
- type: array
items:
$ref: '#/components/schemas/ToolCall'
ChatCompletionResponseBase:
allOf:
- $ref: '#/components/schemas/ResponseBase'
- type: object
title: ChatCompletionResponseBase
properties:
created:
type: integer
example: 1702256327
ChatCompletionResponse:
allOf:
- $ref: '#/components/schemas/ChatCompletionResponseBase'
- type: object
title: ChatCompletionResponse
properties:
choices:
type: array
items:
$ref: '#/components/schemas/ChatCompletionChoice'
required:
- id
- object
- data
- model
- usage
- created
- choices
FIMCompletionResponse:
allOf:
- $ref: '#/components/schemas/ChatCompletionResponse'
- type: object
properties:
model:
type: string
example: codestral-latest
EmbeddingResponseData:
title: EmbeddingResponseData
type: object
properties:
object:
type: string
example: embedding
embedding:
type: array
items:
type: number
example:
- 0.1
- 0.2
- 0.3
index:
type: integer
example: 0
examples:
- object: embedding
embedding:
- 0.1
- 0.2
- 0.3
index: 0
- object: embedding
embedding:
- 0.4
- 0.5
- 0.6
index: 1
EmbeddingResponse:
allOf:
- $ref: '#/components/schemas/ResponseBase'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/EmbeddingResponseData'
required:
- id
- object
- data
- model
- usage
ActivityTaskCompletedResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: ACTIVITY_TASK_COMPLETED
const: ACTIVITY_TASK_COMPLETED
attributes:
$ref: '#/components/schemas/ActivityTaskCompletedAttributesResponse'
description: Event-specific attributes.
title: ActivityTaskCompleted
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when an activity task completes successfully.
Contains timing information about the successful execution.'
ActivityTaskCompletedAttributesResponse:
type: object
properties:
task_id:
type: string
title: Task Id
description: Unique identifier for the activity task within the workflow.
activity_name:
type: string
title: Activity Name
description: The registered name of the activity being executed.
result:
$ref: '#/components/schemas/JSONPayloadResponse'
description: The result returned by the activity.
title: ActivityTaskCompletedAttributes
required:
- task_id
- activity_name
- result
description: Attributes for activity task completed events.
ActivityTaskFailedResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: ACTIVITY_TASK_FAILED
const: ACTIVITY_TASK_FAILED
attributes:
$ref: '#/components/schemas/ActivityTaskFailedAttributes'
description: Event-specific attributes.
title: ActivityTaskFailed
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when an activity task fails after exhausting all retry attempts.
This is a terminal event indicating the activity could not complete successfully.'
ActivityTaskFailedAttributes:
type: object
properties:
task_id:
type: string
title: Task Id
description: Unique identifier for the activity task within the workflow.
activity_name:
type: string
title: Activity Name
description: The registered name of the activity being executed.
attempt:
type: integer
title: Attempt
description: The final attempt number that failed (1-indexed).
failure:
$ref: '#/components/schemas/Failure'
description: Details about the failure that caused the activity to fail.
title: ActivityTaskFailedAttributes
required:
- task_id
- activity_name
- attempt
- failure
description: Attributes for activity task failed events (final failure after all retries).
ActivityTaskRetryingResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: ACTIVITY_TASK_RETRYING
const: ACTIVITY_TASK_RETRYING
attributes:
$ref: '#/components/schemas/ActivityTaskRetryingAttributes'
description: Event-specific attributes.
title: ActivityTaskRetrying
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when an activity task fails and will be retried.
Contains information about the failed attempt and the error that occurred.'
ActivityTaskRetryingAttributes:
type: object
properties:
task_id:
type: string
title: Task Id
description: Unique identifier for the activity task within the workflow.
activity_name:
type: string
title: Activity Name
description: The registered name of the activity being executed.
attempt:
type: integer
title: Attempt
description: The attempt number that failed (1-indexed).
failure:
$ref: '#/components/schemas/Failure'
description: Details about the failure that caused the retry.
title: ActivityTaskRetryingAttributes
required:
- task_id
- activity_name
- attempt
- failure
description: Attributes for activity task retrying events.
ActivityTaskStartedResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: ACTIVITY_TASK_STARTED
const: ACTIVITY_TASK_STARTED
attributes:
$ref: '#/components/schemas/ActivityTaskStartedAttributesResponse'
description: Event-specific attributes.
title: ActivityTaskStarted
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when an activity task begins execution.
This is the first event for an activity, emitted on the first attempt only.
Subsequent retry attempts emit ACTIVITY_TASK_RETRYING instead.'
ActivityTaskStartedAttributesResponse:
type: object
properties:
task_id:
type: string
title: Task Id
description: Unique identifier for the activity task within the workflow.
activity_name:
type: string
title: Activity Name
description: The registered name of the activity being executed.
input:
$ref: '#/components/schemas/JSONPayloadResponse'
description: The input arguments passed to the activity.
title: ActivityTaskStartedAttributes
required:
- task_id
- activity_name
- input
description: Attributes for activity task started events.
BatchExecutionBody:
type: object
properties:
execution_ids:
type: array
items:
type: string
title: Execution Ids
maxItems: 100
minItems: 1
description: List of execution IDs to process
title: BatchExecutionBody
required:
- execution_ids
BatchExecutionResponse:
type: object
properties:
results:
type: object
title: Results
additionalProperties:
$ref: '#/components/schemas/BatchExecutionResult'
description: Mapping of execution_id to result with status and optional error message
title: BatchExecutionResponse
BatchExecutionResult:
type: object
properties:
status:
type: string
title: Status
description: Status of the operation (success/failure)
error:
anyOf:
- type: string
- type: 'null'
title: Error
description: Error message if operation failed
title: BatchExecutionResult
required:
- status
CustomTaskCanceledResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: CUSTOM_TASK_CANCELED
const: CUSTOM_TASK_CANCELED
attributes:
$ref: '#/components/schemas/CustomTaskCanceledAttributes'
description: Event-specific attributes.
title: CustomTaskCanceled
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when a custom task is canceled.
Indicates the task was explicitly stopped before completion.'
CustomTaskCanceledAttributes:
type: object
properties:
custom_task_id:
type: string
title: Custom Task Id
description: Unique identifier for the custom task within the workflow.
custom_task_type:
type: string
title: Custom Task Type
description: The type/category of the custom task (e.g., 'llm_call', 'api_request').
reason:
anyOf:
- type: string
- type: 'null'
title: Reason
description: Optional reason provided for the cancellation.
title: CustomTaskCanceledAttributes
required:
- custom_task_id
- custom_task_type
description: Attributes for custom task canceled events.
CustomTaskCompletedResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: CUSTOM_TASK_COMPLETED
const: CUSTOM_TASK_COMPLETED
attributes:
$ref: '#/components/schemas/CustomTaskCompletedAttributesResponse'
description: Event-specific attributes.
title: CustomTaskCompleted
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when a custom task completes successfully.
Contains the final result of the task execution.'
CustomTaskCompletedAttributesResponse:
type: object
properties:
custom_task_id:
type: string
title: Custom Task Id
description: Unique identifier for the custom task within the workflow.
custom_task_type:
type: string
title: Custom Task Type
description: The type/category of the custom task (e.g., 'llm_call', 'api_request').
payload:
$ref: '#/components/schemas/JSONPayloadResponse'
description: The final result of the custom task.
title: CustomTaskCompletedAttributes
required:
- custom_task_id
- custom_task_type
- payload
description: Attributes for custom task completed events.
CustomTaskFailedResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: CUSTOM_TASK_FAILED
const: CUSTOM_TASK_FAILED
attributes:
$ref: '#/components/schemas/CustomTaskFailedAttributes'
description: Event-specific attributes.
title: CustomTaskFailed
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when a custom task fails.
Contains details about the failure for debugging and error handling.'
CustomTaskFailedAttributes:
type: object
properties:
custom_task_id:
type: string
title: Custom Task Id
description: Unique identifier for the custom task within the workflow.
custom_task_type:
type: string
title: Custom Task Type
description: The type/category of the custom task (e.g., 'llm_call', 'api_request').
failure:
$ref: '#/components/schemas/Failure'
description: Details about the failure that caused the task to fail.
title: CustomTaskFailedAttributes
required:
- custom_task_id
- custom_task_type
- failure
description: Attributes for custom task failed events.
CustomTaskInProgressResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: CUSTOM_TASK_IN_PROGRESS
const: CUSTOM_TASK_IN_PROGRESS
attributes:
$ref: '#/components/schemas/CustomTaskInProgressAttributesResponse'
description: Event-specific attributes.
title: CustomTaskInProgress
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted during custom task execution to report progress.
This event supports streaming updates via JSON or JSON Patch payloads,
enabling real-time progress tracking for long-running tasks.'
CustomTaskInProgressAttributesResponse:
type: object
properties:
custom_task_id:
type: string
title: Custom Task Id
description: Unique identifier for the custom task within the workflow.
custom_task_type:
type: string
title: Custom Task Type
description: The type/category of the custom task (e.g., 'llm_call', 'api_request').
payload:
oneOf:
- $ref: '#/components/schemas/JSONPayloadResponse'
- $ref: '#/components/schemas/JSONPatchPayloadResponse'
discriminator:
propertyName: type
mapping:
json: '#/components/schemas/JSONPayloadResponse'
json_patch: '#/components/schemas/JSONPatchPayloadResponse'
title: Payload
description: The current state or incremental update for the task.
title: CustomTaskInProgressAttributes
required:
- custom_task_id
- custom_task_type
- payload
description: Attributes for custom task in-progress events with streaming updates.
CustomTaskStartedResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: CUSTOM_TASK_STARTED
const: CUSTOM_TASK_STARTED
attributes:
$ref: '#/components/schemas/CustomTaskStartedAttributesResponse'
description: Event-specific attributes.
title: CustomTaskStarted
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when a custom task begins execution.
Custom tasks represent user-defined units of work within a workflow,
such as LLM calls, API requests, or data processing steps.'
CustomTaskStartedAttributesResponse:
type: object
properties:
custom_task_id:
type: string
title: Custom Task Id
description: Unique identifier for the custom task within the workflow.
custom_task_type:
type: string
title: Custom Task Type
description: The type/category of the custom task (e.g., 'llm_call', 'api_request').
payload:
$ref: '#/components/schemas/JSONPayloadResponse'
description: The initial state or payload for the custom task.
title: CustomTaskStartedAttributes
required:
- custom_task_id
- custom_task_type
description: Attributes for custom task started events.
CustomTaskTimedOutResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: CUSTOM_TASK_TIMED_OUT
const: CUSTOM_TASK_TIMED_OUT
attributes:
$ref: '#/components/schemas/CustomTaskTimedOutAttributes'
description: Event-specific attributes.
title: CustomTaskTimedOut
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when a custom task exceeds its timeout.
Indicates the task did not complete within its configured time limit.'
CustomTaskTimedOutAttributes:
type: object
properties:
custom_task_id:
type: string
title: Custom Task Id
description: Unique identifier for the custom task within the workflow.
custom_task_type:
type: string
title: Custom Task Type
description: The type/category of the custom task (e.g., 'llm_call', 'api_request').
timeout_type:
anyOf:
- type: string
- type: 'null'
title: Timeout Type
description: The type of timeout that occurred.
title: CustomTaskTimedOutAttributes
required:
- custom_task_id
- custom_task_type
description: Attributes for custom task timed out events.
DeploymentDetailResponse:
type: object
properties:
id:
type: string
title: Id
format: uuid
description: Unique identifier of the deployment
name:
type: string
title: Name
description: Deployment name
is_active:
type: boolean
title: Is Active
description: Whether at least one worker is currently live
created_at:
type: string
title: Created At
format: date-time
description: When the deployment was first registered
updated_at:
type: string
title: Updated At
format: date-time
description: When the deployment was last updated
workers:
type: array
items:
$ref: '#/components/schemas/DeploymentWorkerResponse'
title: Workers
description: Workers registered for the deployment
title: DeploymentDetailResponse
required:
- id
- name
- is_active
- created_at
- updated_at
- workers
DeploymentListResponse:
type: object
properties:
deployments:
type: array
items:
$ref: '#/components/schemas/DeploymentResponse'
title: Deployments
description: List of deployments
title: DeploymentListResponse
required:
- deployments
DeploymentResponse:
type: object
properties:
id:
type: string
title: Id
format: uuid
description: Unique identifier of the deployment
name:
type: string
title: Name
description: Deployment name
is_active:
type: boolean
title: Is Active
description: Whether at least one worker is currently live
created_at:
type: string
title: Created At
format: date-time
description: When the deployment was first registered
updated_at:
type: string
title: Updated At
format: date-time
description: When the deployment was last updated
title: DeploymentResponse
required:
- id
- name
- is_active
- created_at
- updated_at
DeploymentWorkerResponse:
type: object
properties:
name:
type: string
title: Name
description: Worker name
created_at:
type: string
title: Created At
format: date-time
description: When the worker first registered
updated_at:
type: string
title: Updated At
format: date-time
description: When the worker last registered
title: DeploymentWorkerResponse
required:
- name
- created_at
- updated_at
EncodedPayloadOptions:
type: string
title: EncodedPayloadOptions
enum:
- offloaded
- encrypted
- encrypted-partial
EventProgressStatus:
type: string
title: EventProgressStatus
enum:
- RUNNING
- COMPLETED
- FAILED
EventSource:
type: string
title: EventSource
enum:
- DATABASE
- LIVE
EventType:
type: string
title: EventType
enum:
- EVENT
- EVENT_PROGRESS
Failure:
type: object
properties:
message:
type: string
title: Message
description: A human-readable description of the failure.
title: Failure
required:
- message
description: Represents an error or exception that occurred during execution.
JSONPatchAdd:
type: object
properties:
path:
type: string
title: Path
description: A JSON Pointer (RFC 6901) identifying the target location within the document. Can be a string path (e.g., '/foo/bar'), '/', '', or an empty list [] for root-level operations.
value:
title: Value
description: The value to use for the operation
op:
type: string
title: Op
description: 'Add operation '
const: add
title: JSONPatchAdd
required:
- path
- value
- op
JSONPatchAppend:
type: object
properties:
path:
type: string
title: Path
description: A JSON Pointer (RFC 6901) identifying the target location within the document. Can be a string path (e.g., '/foo/bar'), '/', '', or an empty list [] for root-level operations.
value:
type: string
title: Value
description: The value to use for the operation. A string to append to the existing value
op:
type: string
title: Op
description: '''append'' is an extension for efficient string concatenation in streaming scenarios.'
const: append
title: JSONPatchAppend
required:
- path
- value
- op
JSONPatchPayloadResponse:
type: object
properties:
type:
type: string
title: Type
description: Discriminator indicating this is a JSON Patch payload.
default: json_patch
const: json_patch
value:
type: array
items:
oneOf:
- $ref: '#/components/schemas/JSONPatchAppend'
- $ref: '#/components/schemas/JSONPatchAdd'
- $ref: '#/components/schemas/JSONPatchReplace'
- $ref: '#/components/schemas/JSONPatchRemove'
discriminator:
propertyName: op
mapping:
add: '#/components/schemas/JSONPatchAdd'
append: '#/components/schemas/JSONPatchAppend'
remove: '#/components/schemas/JSONPatchRemove'
replace: '#/components/schemas/JSONPatchReplace'
title: Value
description: The list of JSON Patch operations to apply in order.
title: JSONPatchPayload
required:
- type
- value
description: 'A payload containing a list of JSON Patch operations.
Used for streaming incremental updates to workflow state.'
JSONPatchRemove:
type: object
properties:
path:
type: string
title: Path
description: A JSON Pointer (RFC 6901) identifying the target location within the document. Can be a string path (e.g., '/foo/bar'), '/', '', or an empty list [] for root-level operations.
value:
title: Value
description: The value to use for the operation
op:
type: string
title: Op
description: Remove operation
const: remove
title: JSONPatchRemove
required:
- path
- value
- op
JSONPatchReplace:
type: object
properties:
path:
type: string
title: Path
description: A JSON Pointer (RFC 6901) identifying the target location within the document. Can be a string path (e.g., '/foo/bar'), '/', '', or an empty list [] for root-level operations.
value:
title: Value
description: The value to use for the operation
op:
type: string
title: Op
description: Replace operation
const: replace
title: JSONPatchReplace
required:
- path
- value
- op
JSONPayloadResponse:
type: object
properties:
type:
type: string
title: Type
description: Discriminator indicating this is a raw JSON payload.
default: json
const: json
value:
title: Value
description: The JSON-serializable payload value.
title: JSONPayload
required:
- type
- value
description: 'A payload containing arbitrary JSON data.
Used for complete state snapshots or final results.'
ListWorkflowEventResponse:
type: object
properties:
events:
type: array
items:
oneOf:
- $ref: '#/components/schemas/WorkflowExecutionStartedResponse'
- $ref: '#/components/schemas/WorkflowExecutionCompletedResponse'
- $ref: '#/components/schemas/WorkflowExecutionFailedResponse'
- $ref: '#/components/schemas/WorkflowExecutionCanceledResponse'
- $ref: '#/components/schemas/WorkflowExecutionContinuedAsNewResponse'
- $ref: '#/components/schemas/WorkflowTaskTimedOutResponse'
- $ref: '#/components/schemas/WorkflowTaskFailedResponse'
- $ref: '#/components/schemas/CustomTaskStartedResponse'
- $ref: '#/components/schemas/CustomTaskInProgressResponse'
- $ref: '#/components/schemas/CustomTaskCompletedResponse'
- $ref: '#/components/schemas/CustomTaskFailedResponse'
- $ref: '#/components/schemas/CustomTaskTimedOutResponse'
- $ref: '#/components/schemas/CustomTaskCanceledResponse'
- $ref: '#/components/schemas/ActivityTaskStartedResponse'
- $ref: '#/components/schemas/ActivityTaskCompletedResponse'
- $ref: '#/components/schemas/ActivityTaskRetryingResponse'
- $ref: '#/components/schemas/ActivityTaskFailedResponse'
title: Events
description: List of workflow events.
next_cursor:
anyOf:
- type: string
- type: 'null'
title: Next Cursor
description: Cursor for pagination.
title: ListWorkflowEventResponse
required:
- events
NetworkEncodedInput:
type: object
properties:
b64payload:
type: string
title: B64Payload
description: The encoded payload
encoding_options:
type: array
items:
$ref: '#/components/schemas/EncodedPayloadOptions'
title: Encoding Options
description: The encoding of the payload
default: []
empty:
type: boolean
title: Empty
description: Whether the payload is empty
default: false
title: NetworkEncodedInput
required:
- b64payload
QueryDefinition:
type: object
properties:
name:
type: string
title: Name
description: Name of the query
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Description of the query
input_schema:
type: object
title: Input Schema
additionalProperties: true
description: Input JSON schema of the query's model
output_schema:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Output Schema
additionalProperties: true
description: Output JSON schema of the query's model
title: QueryDefinition
required:
- name
- input_schema
QueryInvocationBody:
type: object
properties:
name:
type: string
title: Name
description: The name of the query to request
input:
anyOf:
- $ref: '#/components/schemas/NetworkEncodedInput'
- type: object
additionalProperties: true
- type: 'null'
title: Input
description: Input data for the query, matching its schema
title: QueryInvocationBody
required:
- name
QueryWorkflowResponse:
type: object
properties:
query_name:
type: string
title: Query Name
result:
title: Result
description: The result of the Query workflow call
title: QueryWorkflowResponse
required:
- query_name
- result
ResetInvocationBody:
type: object
properties:
event_id:
type: integer
title: Event Id
description: The event ID to reset the workflow execution to
reason:
anyOf:
- type: string
- type: 'null'
title: Reason
description: Reason for resetting the workflow execution
exclude_signals:
type: boolean
title: Exclude Signals
description: Whether to exclude signals that happened after the reset point
default: false
exclude_updates:
type: boolean
title: Exclude Updates
description: Whether to exclude updates that happened after the reset point
default: false
title: ResetInvocationBody
required:
- event_id
ScalarMetric:
type: object
properties:
value:
anyOf:
- type: integer
- type: number
title: Value
title: ScalarMetric
required:
- value
description: Scalar metric with a single value.
ScheduleCalendar:
type: object
properties:
second:
type: array
items:
$ref: '#/components/schemas/ScheduleRange'
title: Second
default:
- start: 0
end: 0
step: 0
minute:
type: array
items:
$ref: '#/components/schemas/ScheduleRange'
title: Minute
default:
- start: 0
end: 0
step: 0
hour:
type: array
items:
$ref: '#/components/schemas/ScheduleRange'
title: Hour
default:
- start: 0
end: 0
step: 0
day_of_month:
type: array
items:
$ref: '#/components/schemas/ScheduleRange'
title: Day Of Month
default:
- start: 1
end: 31
step: 0
month:
type: array
items:
$ref: '#/components/schemas/ScheduleRange'
title: Month
default:
- start: 1
end: 12
step: 0
year:
type: array
items:
$ref: '#/components/schemas/ScheduleRange'
title: Year
default: []
day_of_week:
type: array
items:
$ref: '#/components/schemas/ScheduleRange'
title: Day Of Week
default:
- start: 0
end: 6
step: 0
comment:
anyOf:
- type: string
- type: 'null'
title: Comment
title: ScheduleCalendar
ScheduleDefinition:
type: object
properties:
input:
title: Input
description: Input to provide to the workflow when starting it.
calendars:
type: array
items:
$ref: '#/components/schemas/ScheduleCalendar'
title: Calendars
description: Calendar-based specification of times.
intervals:
type: array
items:
$ref: '#/components/schemas/ScheduleInterval'
title: Intervals
description: Interval-based specification of times.
cron_expressions:
type: array
items:
type: string
title: Cron Expressions
description: Cron-based specification of times.
skip:
type: array
items:
$ref: '#/components/schemas/ScheduleCalendar'
title: Skip
description: Set of calendar times to skip.
start_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start At
description: Time after which the first action may be run.
end_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End At
description: Time after which no more actions will be run.
jitter:
anyOf:
- type: string
format: duration
- type: 'null'
title: Jitter
description: 'Jitter to apply each action.
An action''s scheduled time will be incremented by a random value between 0
and this value if present (but not past the next schedule).
'
time_zone_name:
anyOf:
- type: string
- type: 'null'
title: Time Zone Name
description: IANA time zone name, for example ``US/Central``.
policy:
$ref: '#/components/schemas/SchedulePolicy'
description: Policy for the schedule.
schedule_id:
anyOf:
- type: string
- type: 'null'
title: Schedule Id
description: Unique identifier for the schedule.
title: ScheduleDefinition
required:
- input
description: 'Specification of the times scheduled actions may occur.
The times are the union of :py:attr:`calendars`, :py:attr:`intervals`, and
:py:attr:`cron_expressions` excluding anything in :py:attr:`skip`.
Used for input where schedule_id is optional (can be provided or auto-generated).'
ScheduleDefinitionOutput:
type: object
properties:
input:
title: Input
description: Input to provide to the workflow when starting it.
calendars:
type: array
items:
$ref: '#/components/schemas/ScheduleCalendar'
title: Calendars
description: Calendar-based specification of times.
intervals:
type: array
items:
$ref: '#/components/schemas/ScheduleInterval'
title: Intervals
description: Interval-based specification of times.
cron_expressions:
type: array
items:
type: string
title: Cron Expressions
description: Cron-based specification of times.
skip:
type: array
items:
$ref: '#/components/schemas/ScheduleCalendar'
title: Skip
description: Set of calendar times to skip.
start_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start At
description: Time after which the first action may be run.
end_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End At
description: Time after which no more actions will be run.
jitter:
anyOf:
- type: string
format: duration
- type: 'null'
title: Jitter
description: 'Jitter to apply each action.
An action''s scheduled time will be incremented by a random value between 0
and this value if present (but not past the next schedule).
'
time_zone_name:
anyOf:
- type: string
- type: 'null'
title: Time Zone Name
description: IANA time zone name, for example ``US/Central``.
policy:
$ref: '#/components/schemas/SchedulePolicy'
description: Policy for the schedule.
schedule_id:
type: string
title: Schedule Id
description: Unique identifier for the schedule.
title: ScheduleDefinitionOutput
required:
- input
- schedule_id
description: 'Output representation of a schedule with required schedule_id.
Used when returning schedules from the API where schedule_id is always present.'
ScheduleInterval:
type: object
properties:
every:
type: string
title: Every
format: duration
offset:
anyOf:
- type: string
format: duration
- type: 'null'
title: Offset
title: ScheduleInterval
required:
- every
ScheduleOverlapPolicy:
type: integer
title: ScheduleOverlapPolicy
enum:
- 1
- 2
- 3
- 4
- 5
- 6
description: 'Controls what happens when a workflow would be started by a schedule but
one is already running.'
SchedulePolicy:
type: object
properties:
catchup_window_seconds:
type: integer
title: Catchup Window Seconds
description: After a Temporal server is unavailable, amount of time in seconds in the past to execute missed actions.
default: 31536000
overlap:
$ref: '#/components/schemas/ScheduleOverlapPolicy'
description: Policy controlling what to do when a workflow is already running.
default: 1
pause_on_failure:
type: boolean
title: Pause On Failure
description: Whether to pause the schedule after a workflow failure.
default: false
title: SchedulePolicy
ScheduleRange:
type: object
properties:
start:
type: integer
title: Start
end:
type: integer
title: End
default: 0
step:
type: integer
title: Step
default: 0
title: ScheduleRange
required:
- start
SignalDefinition:
type: object
properties:
name:
type: string
title: Name
description: Name of the signal
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Description of the signal
input_schema:
type: object
title: Input Schema
additionalProperties: true
description: Input JSON schema of the signal's model
title: SignalDefinition
required:
- name
- input_schema
SignalInvocationBody:
type: object
properties:
name:
type: string
title: Name
description: The name of the signal to send
input:
anyOf:
- $ref: '#/components/schemas/NetworkEncodedInput'
- type: object
additionalProperties: true
- type: 'null'
title: Input
additionalProperties: true
description: Input data for the signal, matching its schema
title: SignalInvocationBody
required:
- name
SignalWorkflowResponse:
type: object
properties:
message:
type: string
title: Message
default: Signal accepted
title: SignalWorkflowResponse
StreamEventSsePayload:
type: object
properties:
stream:
type: string
title: Stream
timestamp:
type: string
title: Timestamp
format: date-time
data:
oneOf:
- $ref: '#/components/schemas/WorkflowExecutionStartedResponse'
- $ref: '#/components/schemas/WorkflowExecutionCompletedResponse'
- $ref: '#/components/schemas/WorkflowExecutionFailedResponse'
- $ref: '#/components/schemas/WorkflowExecutionCanceledResponse'
- $ref: '#/components/schemas/WorkflowExecutionContinuedAsNewResponse'
- $ref: '#/components/schemas/WorkflowTaskTimedOutResponse'
- $ref: '#/components/schemas/WorkflowTaskFailedResponse'
- $ref: '#/components/schemas/CustomTaskStartedResponse'
- $ref: '#/components/schemas/CustomTaskInProgressResponse'
- $ref: '#/components/schemas/CustomTaskCompletedResponse'
- $ref: '#/components/schemas/CustomTaskFailedResponse'
- $ref: '#/components/schemas/CustomTaskTimedOutResponse'
- $ref: '#/components/schemas/CustomTaskCanceledResponse'
- $ref: '#/components/schemas/ActivityTaskStartedResponse'
- $ref: '#/components/schemas/ActivityTaskCompletedResponse'
- $ref: '#/components/schemas/ActivityTaskRetryingResponse'
- $ref: '#/components/schemas/ActivityTaskFailedResponse'
title: Data
workflow_context:
$ref: '#/components/schemas/StreamEventWorkflowContext'
metadata:
type: object
title: Metadata
additionalProperties: true
broker_sequence:
type: integer
title: Broker Sequence
title: StreamEventSsePayload
required:
- stream
- data
- workflow_context
- broker_sequence
StreamEventWorkflowContext:
type: object
properties:
namespace:
type: string
title: Namespace
workflow_name:
type: string
title: Workflow Name
workflow_exec_id:
type: string
title: Workflow Exec Id
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
root_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Root Workflow Exec Id
title: StreamEventWorkflowContext
required:
- namespace
- workflow_name
- workflow_exec_id
TempoGetTraceResponse:
type: object
properties:
batches:
type: array
items:
$ref: '#/components/schemas/TempoTraceBatch'
title: Batches
description: The batches of the trace
title: TempoGetTraceResponse
description: 'Trace response in OpenTelemetry format.
This is the unified trace format used across all trace providers (Tempo, ClickHouse, etc.).
Regardless of the underlying backend, all trace data is normalized to this Tempo-compatible
OpenTelemetry format to ensure consistency in the API response structure.'
TempoTraceAttribute:
type: object
properties:
key:
type: string
title: Key
description: The key of the attribute
value:
anyOf:
- $ref: '#/components/schemas/TempoTraceAttributeStringValue'
- $ref: '#/components/schemas/TempoTraceAttributeIntValue'
- $ref: '#/components/schemas/TempoTraceAttributeBoolValue'
title: Value
description: The value of the attribute
title: TempoTraceAttribute
required:
- key
- value
TempoTraceAttributeBoolValue:
type: object
properties:
boolValue:
type: boolean
title: Boolvalue
description: The boolean value of the attribute
title: TempoTraceAttributeBoolValue
required:
- boolValue
TempoTraceAttributeIntValue:
type: object
properties:
intValue:
type: string
title: Intvalue
description: The integer value of the attribute
title: TempoTraceAttributeIntValue
required:
- intValue
TempoTraceAttributeStringValue:
type: object
properties:
stringValue:
type: string
title: Stringvalue
description: The string value of the attribute
title: TempoTraceAttributeStringValue
required:
- stringValue
TempoTraceBatch:
type: object
properties:
resource:
$ref: '#/components/schemas/TempoTraceResource'
description: The resource of the batch
scopeSpans:
type: array
items:
$ref: '#/components/schemas/TempoTraceScopeSpan'
title: Scopespans
description: The spans of the scope
title: TempoTraceBatch
required:
- resource
TempoTraceEvent:
type: object
properties:
name:
type: string
title: Name
description: The name of the event
timeUnixNano:
type: string
title: Timeunixnano
description: The time of the event in Unix nano
attributes:
type: array
items:
$ref: '#/components/schemas/TempoTraceAttribute'
title: Attributes
description: The attributes of the event
title: TempoTraceEvent
required:
- name
- timeUnixNano
TempoTraceResource:
type: object
properties:
attributes:
type: array
items:
$ref: '#/components/schemas/TempoTraceAttribute'
title: Attributes
description: The attributes of the resource
title: TempoTraceResource
TempoTraceScope:
type: object
properties:
name:
type: string
title: Name
description: The name of the span
title: TempoTraceScope
required:
- name
TempoTraceScopeKind:
type: string
title: TempoTraceScopeKind
enum:
- SPAN_KIND_INTERNAL
- SPAN_KIND_SERVER
- SPAN_KIND_CLIENT
TempoTraceScopeSpan:
type: object
properties:
scope:
$ref: '#/components/schemas/TempoTraceScope'
description: The scope of the span
spans:
type: array
items:
$ref: '#/components/schemas/TempoTraceSpan'
title: Spans
description: The spans of the scope
title: TempoTraceScopeSpan
required:
- scope
TempoTraceSpan:
type: object
properties:
traceId:
type: string
title: Traceid
description: The trace ID of the scope
spanId:
type: string
title: Spanid
description: The span ID of the scope
parentSpanId:
anyOf:
- type: string
- type: 'null'
title: Parentspanid
description: The parent span ID of the scope
name:
type: string
title: Name
description: The name of the scope
kind:
$ref: '#/components/schemas/TempoTraceScopeKind'
description: The kind of the scope
startTimeUnixNano:
type: string
title: Starttimeunixnano
description: The start time of the scope in Unix nano
endTimeUnixNano:
type: string
title: Endtimeunixnano
description: The end time of the scope in Unix nano
attributes:
type: array
items:
$ref: '#/components/schemas/TempoTraceAttribute'
title: Attributes
description: The attributes of the scope
events:
type: array
items:
$ref: '#/components/schemas/TempoTraceEvent'
title: Events
description: The events of the scope
title: TempoTraceSpan
required:
- traceId
- spanId
- name
- kind
- startTimeUnixNano
- endTimeUnixNano
TimeSeriesMetric:
type: object
properties:
value:
type: array
items:
type: array
prefixItems:
- type: integer
- anyOf:
- type: integer
- type: number
maxItems: 2
minItems: 2
title: Value
title: TimeSeriesMetric
required:
- value
description: Time-series metric with timestamp-value pairs.
UpdateDefinition:
type: object
properties:
name:
type: string
title: Name
description: Name of the update
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Description of the update
input_schema:
type: object
title: Input Schema
additionalProperties: true
description: Input JSON schema of the update's model
output_schema:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Output Schema
additionalProperties: true
description: Output JSON schema of the update's model
title: UpdateDefinition
required:
- name
- input_schema
UpdateInvocationBody:
type: object
properties:
name:
type: string
title: Name
description: The name of the update to request
input:
anyOf:
- $ref: '#/components/schemas/NetworkEncodedInput'
- type: object
additionalProperties: true
- type: 'null'
title: Input
description: Input data for the update, matching its schema
title: UpdateInvocationBody
required:
- name
UpdateWorkflowResponse:
type: object
properties:
update_name:
type: string
title: Update Name
result:
title: Result
description: The result of the Update workflow call
title: UpdateWorkflowResponse
required:
- update_name
- result
WorkerInfo:
type: object
properties:
scheduler_url:
type: string
title: Scheduler Url
namespace:
type: string
title: Namespace
tls:
type: boolean
title: Tls
default: false
title: WorkerInfo
required:
- scheduler_url
- namespace
Workflow:
type: object
properties:
id:
type: string
title: Id
format: uuid
description: Unique identifier of the workflow
name:
type: string
title: Name
description: Name of the workflow
display_name:
type: string
title: Display Name
description: Display name of the workflow
type:
$ref: '#/components/schemas/WorkflowType'
description: Type of the workflow
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Description of the workflow
customer_id:
type: string
title: Customer Id
format: uuid
description: Customer ID of the workflow
workspace_id:
type: string
title: Workspace Id
format: uuid
description: Workspace ID of the workflow
shared_namespace:
anyOf:
- type: string
- type: 'null'
title: Shared Namespace
description: Reserved namespace for shared workflows (e.g., 'shared:my-shared-workflow')
available_in_chat_assistant:
type: boolean
title: Available In Chat Assistant
description: Whether the workflow is available in chat assistant
default: false
is_technical:
type: boolean
title: Is Technical
description: Whether the workflow is technical (e.g. SDK-managed)
default: false
archived:
type: boolean
title: Archived
description: Whether the workflow is archived
default: false
title: Workflow
required:
- id
- name
- display_name
- type
- customer_id
- workspace_id
WorkflowArchiveResponse:
type: object
properties:
workflow:
$ref: '#/components/schemas/Workflow'
description: The workflow spec
title: WorkflowArchiveResponse
required:
- workflow
WorkflowBasicDefinition:
type: object
properties:
id:
type: string
title: Id
format: uuid
name:
type: string
title: Name
description: The name of the workflow
display_name:
type: string
title: Display Name
description: The display name of the workflow
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: A description of the workflow
metadata:
$ref: '#/components/schemas/WorkflowMetadata'
description: Workflow metadata
archived:
type: boolean
title: Archived
description: Whether the workflow is archived
title: WorkflowBasicDefinition
required:
- id
- name
- display_name
- archived
WorkflowCodeDefinition:
type: object
properties:
input_schema:
type: object
title: Input Schema
additionalProperties: true
description: Input schema of the workflow's run method
output_schema:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Output Schema
additionalProperties: true
description: Output schema of the workflow's run method
signals:
type: array
items:
$ref: '#/components/schemas/SignalDefinition'
title: Signals
description: Signal handlers defined by the workflow
queries:
type: array
items:
$ref: '#/components/schemas/QueryDefinition'
title: Queries
description: Query handlers defined by the workflow
updates:
type: array
items:
$ref: '#/components/schemas/UpdateDefinition'
title: Updates
description: Update handlers defined by the workflow
enforce_determinism:
type: boolean
title: Enforce Determinism
description: Whether the workflow enforces deterministic execution
default: false
execution_timeout:
type: number
title: Execution Timeout
description: Maximum total execution time including retries and continue-as-new
title: WorkflowCodeDefinition
required:
- input_schema
WorkflowEventType:
type: string
title: WorkflowEventType
enum:
- WORKFLOW_EXECUTION_STARTED
- WORKFLOW_EXECUTION_COMPLETED
- WORKFLOW_EXECUTION_FAILED
- WORKFLOW_EXECUTION_CANCELED
- WORKFLOW_EXECUTION_CONTINUED_AS_NEW
- WORKFLOW_TASK_TIMED_OUT
- WORKFLOW_TASK_FAILED
- CUSTOM_TASK_STARTED
- CUSTOM_TASK_IN_PROGRESS
- CUSTOM_TASK_COMPLETED
- CUSTOM_TASK_FAILED
- CUSTOM_TASK_TIMED_OUT
- CUSTOM_TASK_CANCELED
- ACTIVITY_TASK_STARTED
- ACTIVITY_TASK_COMPLETED
- ACTIVITY_TASK_RETRYING
- ACTIVITY_TASK_FAILED
WorkflowExecutionCanceledResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: WORKFLOW_EXECUTION_CANCELED
const: WORKFLOW_EXECUTION_CANCELED
attributes:
$ref: '#/components/schemas/WorkflowExecutionCanceledAttributes'
description: Event-specific attributes.
title: WorkflowExecutionCanceled
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when a workflow execution is canceled.
This is a terminal event indicating the workflow was explicitly canceled.'
WorkflowExecutionCanceledAttributes:
type: object
properties:
task_id:
type: string
title: Task Id
description: Unique identifier for the task within the workflow execution.
reason:
anyOf:
- type: string
- type: 'null'
title: Reason
description: Optional reason provided for the cancellation.
title: WorkflowExecutionCanceledAttributes
required:
- task_id
description: Attributes for workflow execution canceled events.
WorkflowExecutionCompletedResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: WORKFLOW_EXECUTION_COMPLETED
const: WORKFLOW_EXECUTION_COMPLETED
attributes:
$ref: '#/components/schemas/WorkflowExecutionCompletedAttributesResponse'
description: Event-specific attributes.
title: WorkflowExecutionCompleted
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when a workflow execution completes successfully.
This is a terminal event indicating the workflow finished without errors.'
WorkflowExecutionCompletedAttributesResponse:
type: object
properties:
task_id:
type: string
title: Task Id
description: Unique identifier for the task within the workflow execution.
result:
$ref: '#/components/schemas/JSONPayloadResponse'
description: The final result returned by the workflow.
title: WorkflowExecutionCompletedAttributes
required:
- task_id
- result
description: Attributes for workflow execution completed events.
WorkflowExecutionContinuedAsNewResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: WORKFLOW_EXECUTION_CONTINUED_AS_NEW
const: WORKFLOW_EXECUTION_CONTINUED_AS_NEW
attributes:
$ref: '#/components/schemas/WorkflowExecutionContinuedAsNewAttributesResponse'
description: Event-specific attributes.
title: WorkflowExecutionContinuedAsNew
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when a workflow continues as a new execution.
This occurs when a workflow uses continue-as-new to reset its history
while maintaining logical continuity.'
WorkflowExecutionContinuedAsNewAttributesResponse:
type: object
properties:
task_id:
type: string
title: Task Id
description: Unique identifier for the task within the workflow execution.
new_execution_run_id:
type: string
title: New Execution Run Id
description: The run ID of the new workflow execution that continues this workflow.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the continued workflow.
input:
$ref: '#/components/schemas/JSONPayloadResponse'
description: The input arguments passed to the new workflow execution.
title: WorkflowExecutionContinuedAsNewAttributes
required:
- task_id
- new_execution_run_id
- workflow_name
- input
description: Attributes for workflow execution continued-as-new events.
WorkflowExecutionFailedResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: WORKFLOW_EXECUTION_FAILED
const: WORKFLOW_EXECUTION_FAILED
attributes:
$ref: '#/components/schemas/WorkflowExecutionFailedAttributes'
description: Event-specific attributes.
title: WorkflowExecutionFailed
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when a workflow execution fails due to an unhandled exception.
This is a terminal event indicating the workflow ended with an error.'
WorkflowExecutionFailedAttributes:
type: object
properties:
task_id:
type: string
title: Task Id
description: Unique identifier for the task within the workflow execution.
failure:
$ref: '#/components/schemas/Failure'
description: Details about the failure that caused the workflow to fail.
title: WorkflowExecutionFailedAttributes
required:
- task_id
- failure
description: Attributes for workflow execution failed events.
WorkflowExecutionListResponse:
type: object
properties:
executions:
type: array
items:
$ref: '#/components/schemas/WorkflowExecutionWithoutResultResponse'
title: Executions
description: A list of workflow executions
next_page_token:
anyOf:
- type: string
- type: 'null'
title: Next Page Token
description: Token to use for fetching the next page of results. Null if this is the last page.
title: WorkflowExecutionListResponse
required:
- executions
WorkflowExecutionProgressTraceEvent:
type: object
properties:
type:
$ref: '#/components/schemas/EventType'
default: EVENT_PROGRESS
name:
type: string
title: Name
description: Name of the event
id:
type: string
title: Id
description: The ID of the event
timestamp_unix_nano:
type: integer
title: Timestamp Unix Nano
description: The timestamp of the event in nanoseconds since the Unix epoch
attributes:
type: object
title: Attributes
additionalProperties:
$ref: '#/components/schemas/WorkflowExecutionTraceSummaryAttributesValues'
description: The attributes of the event
internal:
type: boolean
title: Internal
description: Whether the event is internal
default: false
status:
$ref: '#/components/schemas/EventProgressStatus'
description: The progress message
default: RUNNING
start_time_unix_ms:
type: integer
title: Start Time Unix Ms
description: The start time of the event in milliseconds since the Unix epoch
end_time_unix_ms:
anyOf:
- type: integer
- type: 'null'
title: End Time Unix Ms
description: The end time of the event in milliseconds since the Unix epoch
error:
anyOf:
- type: string
- type: 'null'
title: Error
description: The error message, if any
title: WorkflowExecutionProgressTraceEvent
required:
- name
- id
- timestamp_unix_nano
- attributes
- start_time_unix_ms
WorkflowExecutionRequest:
type: object
properties:
execution_id:
anyOf:
- type: string
maxLength: 256
- type: 'null'
title: Execution Id
description: Allows you to specify a custom execution ID. If not provided, a random ID will be generated.
input:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Input
additionalProperties: true
description: The input to the workflow. This should be a dictionary that matches the workflow's input schema.
encoded_input:
anyOf:
- $ref: '#/components/schemas/NetworkEncodedInput'
- type: 'null'
description: Encoded input to the workflow, used when payload encoding is enabled.
wait_for_result:
type: boolean
title: Wait For Result
description: If true, wait for the workflow to complete and return the result directly.
default: false
timeout_seconds:
anyOf:
- type: number
- type: 'null'
title: Timeout Seconds
description: Maximum time to wait for completion when wait_for_result is true.
custom_tracing_attributes:
anyOf:
- type: object
additionalProperties:
type: string
- type: 'null'
title: Custom Tracing Attributes
task_queue:
anyOf:
- type: string
- type: 'null'
title: Task Queue
description: Deprecated. Use deployment_name instead.
deprecated: true
deployment_name:
anyOf:
- type: string
- type: 'null'
title: Deployment Name
description: Name of the deployment to route this execution to
title: WorkflowExecutionRequest
WorkflowExecutionResponse:
type: object
properties:
workflow_name:
type: string
title: Workflow Name
description: The name of the workflow
execution_id:
type: string
title: Execution Id
description: The ID of the workflow execution
parent_execution_id:
anyOf:
- type: string
- type: 'null'
title: Parent Execution Id
description: The parent execution ID of the workflow execution
root_execution_id:
type: string
title: Root Execution Id
description: The root execution ID of the workflow execution
status:
anyOf:
- $ref: '#/components/schemas/WorkflowExecutionStatus'
- type: 'null'
description: The status of the workflow execution
start_time:
type: string
title: Start Time
format: date-time
description: The start time of the workflow execution
end_time:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Time
description: The end time of the workflow execution, if available
total_duration_ms:
anyOf:
- type: integer
- type: 'null'
title: Total Duration Ms
description: The total duration of the trace in milliseconds
result:
anyOf:
- {}
- type: 'null'
title: Result
description: The result of the workflow execution, if available
title: WorkflowExecutionResponse
required:
- workflow_name
- execution_id
- root_execution_id
- status
- start_time
- end_time
- result
WorkflowExecutionStartedResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: WORKFLOW_EXECUTION_STARTED
const: WORKFLOW_EXECUTION_STARTED
attributes:
$ref: '#/components/schemas/WorkflowExecutionStartedAttributesResponse'
description: Event-specific attributes.
title: WorkflowExecutionStarted
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when a workflow execution begins.
This is the first event in any workflow execution lifecycle.'
WorkflowExecutionStartedAttributesResponse:
type: object
properties:
task_id:
type: string
title: Task Id
description: Unique identifier for the task within the workflow execution.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow being executed.
input:
$ref: '#/components/schemas/JSONPayloadResponse'
description: The input arguments passed to the workflow.
title: WorkflowExecutionStartedAttributes
required:
- task_id
- workflow_name
- input
description: Attributes for workflow execution started events.
WorkflowExecutionStatus:
type: string
title: WorkflowExecutionStatus
enum:
- RUNNING
- COMPLETED
- FAILED
- CANCELED
- TERMINATED
- CONTINUED_AS_NEW
- TIMED_OUT
- RETRYING_AFTER_ERROR
WorkflowExecutionSyncResponse:
type: object
properties:
workflow_name:
type: string
title: Workflow Name
description: Name of the workflow that was executed
execution_id:
type: string
title: Execution Id
description: ID of the workflow execution
result:
title: Result
description: The result of the workflow execution
title: WorkflowExecutionSyncResponse
required:
- workflow_name
- execution_id
- result
description: Response model for synchronous workflow execution
WorkflowExecutionTraceEvent:
type: object
properties:
type:
$ref: '#/components/schemas/EventType'
default: EVENT
name:
type: string
title: Name
description: Name of the event
id:
type: string
title: Id
description: The ID of the event
timestamp_unix_nano:
type: integer
title: Timestamp Unix Nano
description: The timestamp of the event in nanoseconds since the Unix epoch
attributes:
type: object
title: Attributes
additionalProperties:
$ref: '#/components/schemas/WorkflowExecutionTraceSummaryAttributesValues'
description: The attributes of the event
internal:
type: boolean
title: Internal
description: Whether the event is internal
default: false
title: WorkflowExecutionTraceEvent
required:
- name
- id
- timestamp_unix_nano
- attributes
WorkflowExecutionTraceEventsResponse:
type: object
properties:
workflow_name:
type: string
title: Workflow Name
description: The name of the workflow
execution_id:
type: string
title: Execution Id
description: The ID of the workflow execution
parent_execution_id:
anyOf:
- type: string
- type: 'null'
title: Parent Execution Id
description: The parent execution ID of the workflow execution
root_execution_id:
type: string
title: Root Execution Id
description: The root execution ID of the workflow execution
status:
anyOf:
- $ref: '#/components/schemas/WorkflowExecutionStatus'
- type: 'null'
description: The status of the workflow execution
start_time:
type: string
title: Start Time
format: date-time
description: The start time of the workflow execution
end_time:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Time
description: The end time of the workflow execution, if available
total_duration_ms:
anyOf:
- type: integer
- type: 'null'
title: Total Duration Ms
description: The total duration of the trace in milliseconds
result:
anyOf:
- {}
- type: 'null'
title: Result
description: The result of the workflow execution, if available
events:
type: array
items:
anyOf:
- $ref: '#/components/schemas/WorkflowExecutionTraceEvent'
- $ref: '#/components/schemas/WorkflowExecutionProgressTraceEvent'
title: Events
description: The events of the workflow execution
title: WorkflowExecutionTraceEventsResponse
required:
- workflow_name
- execution_id
- root_execution_id
- status
- start_time
- end_time
- result
WorkflowExecutionTraceOTelResponse:
type: object
properties:
workflow_name:
type: string
title: Workflow Name
description: The name of the workflow
execution_id:
type: string
title: Execution Id
description: The ID of the workflow execution
parent_execution_id:
anyOf:
- type: string
- type: 'null'
title: Parent Execution Id
description: The parent execution ID of the workflow execution
root_execution_id:
type: string
title: Root Execution Id
description: The root execution ID of the workflow execution
status:
anyOf:
- $ref: '#/components/schemas/WorkflowExecutionStatus'
- type: 'null'
description: The status of the workflow execution
start_time:
type: string
title: Start Time
format: date-time
description: The start time of the workflow execution
end_time:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Time
description: The end time of the workflow execution, if available
total_duration_ms:
anyOf:
- type: integer
- type: 'null'
title: Total Duration Ms
description: The total duration of the trace in milliseconds
result:
anyOf:
- {}
- type: 'null'
title: Result
description: The result of the workflow execution, if available
data_source:
type: string
title: Data Source
description: The data source of the trace
otel_trace_id:
anyOf:
- type: string
- type: 'null'
title: Otel Trace Id
description: The ID of the trace
otel_trace_data:
anyOf:
- $ref: '#/components/schemas/TempoGetTraceResponse'
- type: 'null'
description: The raw OpenTelemetry trace data
title: WorkflowExecutionTraceOTelResponse
required:
- workflow_name
- execution_id
- root_execution_id
- status
- start_time
- end_time
- result
- data_source
WorkflowExecutionTraceSummaryAttributesValues:
anyOf:
- type: string
- type: integer
- type: number
- type: boolean
- type: 'null'
WorkflowExecutionTraceSummaryResponse:
type: object
properties:
workflow_name:
type: string
title: Workflow Name
description: The name of the workflow
execution_id:
type: string
title: Execution Id
description: The ID of the workflow execution
parent_execution_id:
anyOf:
- type: string
- type: 'null'
title: Parent Execution Id
description: The parent execution ID of the workflow execution
root_execution_id:
type: string
title: Root Execution Id
description: The root execution ID of the workflow execution
status:
anyOf:
- $ref: '#/components/schemas/WorkflowExecutionStatus'
- type: 'null'
description: The status of the workflow execution
start_time:
type: string
title: Start Time
format: date-time
description: The start time of the workflow execution
end_time:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Time
description: The end time of the workflow execution, if available
total_duration_ms:
anyOf:
- type: integer
- type: 'null'
title: Total Duration Ms
description: The total duration of the trace in milliseconds
result:
anyOf:
- {}
- type: 'null'
title: Result
description: The result of the workflow execution, if available
span_tree:
anyOf:
- $ref: '#/components/schemas/WorkflowExecutionTraceSummarySpan'
- type: 'null'
description: The root span of the trace
title: WorkflowExecutionTraceSummaryResponse
required:
- workflow_name
- execution_id
- root_execution_id
- status
- start_time
- end_time
- result
WorkflowExecutionTraceSummarySpan:
type: object
properties:
span_id:
type: string
title: Span Id
description: The ID of the span
name:
type: string
title: Name
description: The name of the span
start_time_unix_nano:
type: integer
title: Start Time Unix Nano
description: The start time of the span in nanoseconds since the Unix epoch
end_time_unix_nano:
anyOf:
- type: integer
- type: 'null'
title: End Time Unix Nano
description: The end time of the span in nanoseconds since the Unix epoch
attributes:
type: object
title: Attributes
additionalProperties:
$ref: '#/components/schemas/WorkflowExecutionTraceSummaryAttributesValues'
description: The attributes of the span
events:
type: array
items:
$ref: '#/components/schemas/WorkflowExecutionTraceEvent'
title: Events
description: The events of the span
children:
type: array
items:
$ref: '#/components/schemas/WorkflowExecutionTraceSummarySpan'
title: Children
description: The child spans of the span
title: WorkflowExecutionTraceSummarySpan
required:
- span_id
- name
- start_time_unix_nano
- end_time_unix_nano
- attributes
- events
WorkflowExecutionWithoutResultResponse:
type: object
properties:
workflow_name:
type: string
title: Workflow Name
description: The name of the workflow
execution_id:
type: string
title: Execution Id
description: The ID of the workflow execution
parent_execution_id:
anyOf:
- type: string
- type: 'null'
title: Parent Execution Id
description: The parent execution ID of the workflow execution
root_execution_id:
type: string
title: Root Execution Id
description: The root execution ID of the workflow execution
status:
anyOf:
- $ref: '#/components/schemas/WorkflowExecutionStatus'
- type: 'null'
description: The status of the workflow execution
start_time:
type: string
title: Start Time
format: date-time
description: The start time of the workflow execution
end_time:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Time
description: The end time of the workflow execution, if available
total_duration_ms:
anyOf:
- type: integer
- type: 'null'
title: Total Duration Ms
description: The total duration of the trace in milliseconds
title: WorkflowExecutionWithoutResultResponse
required:
- workflow_name
- execution_id
- root_execution_id
- status
- start_time
- end_time
WorkflowGetResponse:
type: object
properties:
workflow:
$ref: '#/components/schemas/WorkflowWithWorkerStatus'
description: The workflow spec
title: WorkflowGetResponse
required:
- workflow
WorkflowListResponse:
type: object
properties:
workflows:
type: array
items:
$ref: '#/components/schemas/WorkflowBasicDefinition'
title: Workflows
description: A list of workflows
next_cursor:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Next Cursor
title: WorkflowListResponse
required:
- beta.workflows
- next_cursor
WorkflowMetadata:
type: object
properties:
shared_namespace:
anyOf:
- type: string
- type: 'null'
title: Shared Namespace
description: Namespace for shared workflows, None if user-owned
title: WorkflowMetadata
WorkflowMetrics:
type: object
properties:
execution_count:
$ref: '#/components/schemas/ScalarMetric'
success_count:
$ref: '#/components/schemas/ScalarMetric'
error_count:
$ref: '#/components/schemas/ScalarMetric'
average_latency_ms:
$ref: '#/components/schemas/ScalarMetric'
latency_over_time:
$ref: '#/components/schemas/TimeSeriesMetric'
retry_rate:
$ref: '#/components/schemas/ScalarMetric'
title: WorkflowMetrics
required:
- execution_count
- success_count
- error_count
- average_latency_ms
- latency_over_time
- retry_rate
description: 'Complete metrics for a specific workflow.
This type combines all metric categories.'
WorkflowRegistration:
type: object
properties:
id:
type: string
title: Id
format: uuid
description: Unique identifier of the workflow registration
task_queue:
type: string
title: Task Queue
description: Project name of the workflow
definition:
$ref: '#/components/schemas/WorkflowCodeDefinition'
workflow_id:
type: string
title: Workflow Id
format: uuid
description: Workflow ID of the workflow
workflow:
anyOf:
- $ref: '#/components/schemas/Workflow'
- type: 'null'
description: Workflow of the workflow registration
compatible_with_chat_assistant:
type: boolean
title: Compatible With Chat Assistant
description: Whether the workflow is compatible with chat assistant
default: false
title: WorkflowRegistration
required:
- id
- task_queue
- definition
- workflow_id
WorkflowRegistrationGetResponse:
type: object
properties:
workflow_registration:
$ref: '#/components/schemas/WorkflowRegistrationWithWorkerStatus'
description: The workflow registration
workflow_version:
$ref: '#/components/schemas/WorkflowRegistrationWithWorkerStatus'
description: 'Deprecated: use workflow_registration'
readOnly: true
title: WorkflowRegistrationGetResponse
required:
- workflow_registration
- workflow_version
WorkflowRegistrationListResponse:
type: object
properties:
workflow_registrations:
type: array
items:
$ref: '#/components/schemas/WorkflowRegistration'
title: Workflow Registrations
description: A list of workflow registrations
next_cursor:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Next Cursor
workflow_versions:
type: array
items:
$ref: '#/components/schemas/WorkflowRegistration'
title: Workflow Versions
description: 'Deprecated: use workflow_registrations'
readOnly: true
title: WorkflowRegistrationListResponse
required:
- workflow_registrations
- next_cursor
- workflow_versions
WorkflowRegistrationWithWorkerStatus:
type: object
properties:
id:
type: string
title: Id
format: uuid
description: Unique identifier of the workflow registration
task_queue:
type: string
title: Task Queue
description: Project name of the workflow
definition:
$ref: '#/components/schemas/WorkflowCodeDefinition'
workflow_id:
type: string
title: Workflow Id
format: uuid
description: Workflow ID of the workflow
workflow:
anyOf:
- $ref: '#/components/schemas/Workflow'
- type: 'null'
description: Workflow of the workflow registration
compatible_with_chat_assistant:
type: boolean
title: Compatible With Chat Assistant
description: Whether the workflow is compatible with chat assistant
default: false
active:
type: boolean
title: Active
description: Whether the workflow registration is active
title: WorkflowRegistrationWithWorkerStatus
required:
- id
- task_queue
- definition
- workflow_id
- active
WorkflowScheduleListResponse:
type: object
properties:
schedules:
type: array
items:
$ref: '#/components/schemas/ScheduleDefinitionOutput'
title: Schedules
description: A list of workflow schedules
title: WorkflowScheduleListResponse
required:
- schedules
WorkflowScheduleRequest:
type: object
properties:
schedule:
$ref: '#/components/schemas/ScheduleDefinition'
description: The schedule definition
workflow_registration_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workflow Registration Id
description: The ID of the workflow registration to schedule
workflow_version_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workflow Version Id
description: 'Deprecated: use workflow_registration_id'
workflow_identifier:
anyOf:
- type: string
- type: 'null'
title: Workflow Identifier
description: The name or ID of the workflow to schedule
workflow_task_queue:
anyOf:
- type: string
- type: 'null'
title: Workflow Task Queue
description: Deprecated. Use deployment_name instead.
deprecated: true
schedule_id:
anyOf:
- type: string
- type: 'null'
title: Schedule Id
description: Allows you to specify a custom schedule ID. If not provided, a random ID will be generated.
deployment_name:
anyOf:
- type: string
- type: 'null'
title: Deployment Name
description: Name of the deployment to route this schedule to
title: WorkflowScheduleRequest
required:
- schedule
WorkflowScheduleResponse:
type: object
properties:
schedule_id:
type: string
title: Schedule Id
description: The ID of the schedule
title: WorkflowScheduleResponse
required:
- schedule_id
WorkflowTaskFailedResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: WORKFLOW_TASK_FAILED
const: WORKFLOW_TASK_FAILED
attributes:
$ref: '#/components/schemas/WorkflowTaskFailedAttributes'
description: Event-specific attributes.
title: WorkflowTaskFailed
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when a workflow task fails.
This indicates an error occurred during workflow task execution,
which may trigger a retry depending on configuration.'
WorkflowTaskFailedAttributes:
type: object
properties:
task_id:
type: string
title: Task Id
description: Unique identifier for the task within the workflow execution.
failure:
$ref: '#/components/schemas/Failure'
description: Details about the failure that caused the task to fail.
title: WorkflowTaskFailedAttributes
required:
- task_id
- failure
description: Attributes for workflow task failed events.
WorkflowTaskTimedOutResponse:
type: object
properties:
event_id:
type: string
title: Event Id
description: Unique identifier for this event instance.
event_timestamp:
type: integer
title: Event Timestamp
description: Unix timestamp in nanoseconds when the event was created.
root_workflow_exec_id:
type: string
title: Root Workflow Exec Id
description: Execution ID of the root workflow that initiated this execution chain.
parent_workflow_exec_id:
anyOf:
- type: string
- type: 'null'
title: Parent Workflow Exec Id
description: Execution ID of the parent workflow that initiated this execution. If this is a root workflow, this field is not set.
workflow_exec_id:
type: string
title: Workflow Exec Id
description: Execution ID of the workflow that emitted this event.
workflow_run_id:
type: string
title: Workflow Run Id
description: Run ID of the workflow execution. Changes on continue-as-new while workflow_exec_id stays the same.
workflow_name:
type: string
title: Workflow Name
description: The registered name of the workflow that emitted this event.
event_type:
type: string
title: Event Type
description: Event type discriminator.
default: WORKFLOW_TASK_TIMED_OUT
const: WORKFLOW_TASK_TIMED_OUT
attributes:
$ref: '#/components/schemas/WorkflowTaskTimedOutAttributes'
description: Event-specific attributes.
title: WorkflowTaskTimedOut
required:
- event_id
- event_timestamp
- root_workflow_exec_id
- parent_workflow_exec_id
- workflow_exec_id
- workflow_run_id
- workflow_name
- event_type
- attributes
description: 'Emitted when a workflow task times out.
This indicates the workflow task (a unit of workflow execution) exceeded
its configured timeout.'
WorkflowTaskTimedOutAttributes:
type: object
properties:
task_id:
type: string
title: Task Id
description: Unique identifier for the task within the workflow execution.
timeout_type:
anyOf:
- type: string
- type: 'null'
title: Timeout Type
description: The type of timeout that occurred (e.g., 'START_TO_CLOSE', 'SCHEDULE_TO_START').
title: WorkflowTaskTimedOutAttributes
required:
- task_id
description: Attributes for workflow task timed out events.
WorkflowType:
type: string
title: WorkflowType
enum:
- code
WorkflowUnarchiveResponse:
type: object
properties:
workflow:
$ref: '#/components/schemas/Workflow'
description: The workflow spec
title: WorkflowUnarchiveResponse
required:
- workflow
WorkflowUpdateRequest:
type: object
properties:
display_name:
anyOf:
- type: string
maxLength: 128
- type: 'null'
title: Display Name
description: New display name value
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: New description value
available_in_chat_assistant:
anyOf:
- type: boolean
- type: 'null'
title: Available In Chat Assistant
description: Whether to make the workflow available in the chat assistant
title: WorkflowUpdateRequest
WorkflowUpdateResponse:
type: object
properties:
workflow:
$ref: '#/components/schemas/Workflow'
description: Updated workflow
title: WorkflowUpdateResponse
required:
- workflow
WorkflowWithWorkerStatus:
type: object
properties:
id:
type: string
title: Id
format: uuid
description: Unique identifier of the workflow
name:
type: string
title: Name
description: Name of the workflow
display_name:
type: string
title: Display Name
description: Display name of the workflow
type:
$ref: '#/components/schemas/WorkflowType'
description: Type of the workflow
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Description of the workflow
customer_id:
type: string
title: Customer Id
format: uuid
description: Customer ID of the workflow
workspace_id:
type: string
title: Workspace Id
format: uuid
description: Workspace ID of the workflow
shared_namespace:
anyOf:
- type: string
- type: 'null'
title: Shared Namespace
description: Reserved namespace for shared workflows (e.g., 'shared:my-shared-workflow')
available_in_chat_assistant:
type: boolean
title: Available In Chat Assistant
description: Whether the workflow is available in chat assistant
default: false
is_technical:
type: boolean
title: Is Technical
description: Whether the workflow is technical (e.g. SDK-managed)
default: false
archived:
type: boolean
title: Archived
description: Whether the workflow is archived
default: false
active:
type: boolean
title: Active
description: Whether the workflow is active
title: WorkflowWithWorkerStatus
required:
- id
- name
- display_name
- type
- customer_id
- workspace_id
- active
AuthUrlResponse:
type: object
properties:
auth_url:
type: string
title: Auth Url
ttl:
type: integer
title: Ttl
title: AuthUrlResponse
required:
- auth_url
- ttl
AuthenticationConfiguration:
type: object
properties:
name:
type: string
title: Name
authentication_type:
$ref: '#/components/schemas/OutboundAuthenticationType'
is_default:
type: boolean
title: Is Default
default: false
title: AuthenticationConfiguration
required:
- name
- authentication_type
ConnectionCredentials:
type: object
properties:
oauth:
anyOf:
- $ref: '#/components/schemas/OAuth2Token'
- type: 'null'
headers:
anyOf:
- type: object
additionalProperties:
type: string
- type: 'null'
title: Headers
bearer_token:
anyOf:
- type: string
- type: 'null'
title: Bearer Token
title: ConnectionCredentials
ConnectorAuthenticationHeader:
type: object
properties:
name:
type: string
title: Name
is_required:
type: boolean
title: Is Required
default: true
is_secret:
type: boolean
title: Is Secret
default: true
title: ConnectorAuthenticationHeader
required:
- name
CredentialsCreateOrUpdate:
type: object
properties:
name:
type: string
title: Name
description: Name of the credentials. Use this name to access or modify your
credentials.
is_default:
anyOf:
- type: boolean
- type: 'null'
title: Is Default
description: 'Controls whether this credential is the default for its auth method.
On creation: if no credential exists yet for this auth method, the credential
is automatically set as default when is_default is true or omitted; setting
is_default to false is rejected because a default must exist. If other credentials
already exist, setting is_default to true promotes this credential (demoting
the previous default); false or omitted creates it as non-default. On update:
true promotes this credential, false is rejected if it is currently the default
(promote another credential first), omitted leaves the default status unchanged.'
credentials:
anyOf:
- $ref: '#/components/schemas/ConnectionCredentials'
- type: 'null'
description: The credential data (headers, bearer_token).
title: CredentialsCreateOrUpdate
required:
- name
description: Request to create or update non-OAuth2 credentials for a connector.
CredentialsResponse:
type: object
properties:
credentials:
type: array
items:
$ref: '#/components/schemas/AuthenticationConfiguration'
title: Credentials
connector_preset_credentials_for_auth:
type: array
items:
$ref: '#/components/schemas/OutboundAuthenticationType'
title: Connector Preset Credentials For Auth
default: []
title: CredentialsResponse
required:
- credentials
MCPSupportedLanguage:
type: string
title: MCPSupportedLanguage
enum:
- en
- fr
- de
- es
- pl
- it
- ar
- pt-BR
- nl
MCPTool:
type: object
properties:
name:
type: string
title: Name
title:
anyOf:
- type: string
- type: 'null'
title: Title
description:
anyOf:
- type: string
- type: 'null'
title: Description
inputSchema:
type: object
title: Inputschema
additionalProperties: true
outputSchema:
anyOf:
- type: object
additionalProperties: true
- type: 'null'
title: Outputschema
icons:
anyOf:
- type: array
items:
$ref: '#/components/schemas/MCPServerIcon'
- type: 'null'
title: Icons
annotations:
anyOf:
- $ref: '#/components/schemas/ToolAnnotations'
- type: 'null'
_meta:
anyOf:
- $ref: '#/components/schemas/MCPToolMeta'
- type: 'null'
execution:
anyOf:
- $ref: '#/components/schemas/ToolExecution'
- type: 'null'
title: MCPTool
required:
- name
- inputSchema
additionalProperties: true
MCPToolMeta:
type: object
properties:
ui:
anyOf:
- $ref: '#/components/schemas/MCPUIToolMeta'
- type: 'null'
ai.mistral/turbine:
anyOf:
- $ref: '#/components/schemas/TurbineToolMeta'
- type: 'null'
title: MCPToolMeta
additionalProperties: true
description: 'Typed _meta for MCP tools.
Only the ''ui'' field is typed. Other fields are allowed via extra="allow".'
MCPUIToolMeta:
type: object
properties:
resourceUri:
anyOf:
- type: string
- type: 'null'
title: Resourceuri
visibility:
anyOf:
- type: array
items:
type: string
enum:
- model
- app
- type: 'null'
title: Visibility
title: MCPUIToolMeta
additionalProperties: true
description: UI metadata for tools that reference UI resources.
OAuth2Token:
type: object
properties:
access_token:
type: string
title: Access Token
token_type:
type: string
title: Token Type
default: Bearer
const: Bearer
expires_in:
anyOf:
- type: integer
- type: 'null'
title: Expires In
scope:
anyOf:
- type: string
- type: 'null'
title: Scope
refresh_token:
anyOf:
- type: string
- type: 'null'
title: Refresh Token
expires_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Expires At
title: OAuth2Token
required:
- access_token
OutboundAuthenticationType:
type: string
title: OutboundAuthenticationType
enum:
- oauth2
- bearer
- none
PublicAuthenticationMethod:
type: object
properties:
method_type:
$ref: '#/components/schemas/OutboundAuthenticationType'
headers:
anyOf:
- type: array
items:
$ref: '#/components/schemas/ConnectorAuthenticationHeader'
- type: 'null'
title: Headers
title: PublicAuthenticationMethod
required:
- method_type
description: Public view of an authentication method, without secrets.
ToolAnnotations:
type: object
properties:
title:
anyOf:
- type: string
- type: 'null'
title: Title
readOnlyHint:
anyOf:
- type: boolean
- type: 'null'
title: Readonlyhint
destructiveHint:
anyOf:
- type: boolean
- type: 'null'
title: Destructivehint
idempotentHint:
anyOf:
- type: boolean
- type: 'null'
title: Idempotenthint
openWorldHint:
anyOf:
- type: boolean
- type: 'null'
title: Openworldhint
title: ToolAnnotations
additionalProperties: true
description: 'Additional properties describing a Tool to clients.
NOTE: all properties in ToolAnnotations are **hints**.
They are not guaranteed to provide a faithful description of
tool behavior (including descriptive properties like `title`).
Clients should never make tool use decisions based on ToolAnnotations
received from untrusted servers.'
ToolExecution:
type: object
properties:
taskSupport:
anyOf:
- type: string
enum:
- forbidden
- optional
- required
- type: 'null'
title: Tasksupport
title: ToolExecution
additionalProperties: true
description: Execution-related properties for a tool.
ToolType:
type: string
title: ToolType
enum:
- rag
- image
- code
- event
TurbineToolLocale:
type: object
properties:
name:
anyOf:
- type: object
propertyNames:
$ref: '#/components/schemas/MCPSupportedLanguage'
additionalProperties:
type: string
- type: 'null'
title: Name
description:
anyOf:
- type: object
propertyNames:
$ref: '#/components/schemas/MCPSupportedLanguage'
additionalProperties:
type: string
- type: 'null'
title: Description
usage_sentence:
anyOf:
- type: object
propertyNames:
$ref: '#/components/schemas/MCPSupportedLanguage'
additionalProperties:
type: string
- type: 'null'
title: Usage Sentence
working_description:
anyOf:
- type: object
propertyNames:
$ref: '#/components/schemas/MCPSupportedLanguage'
additionalProperties:
type: string
- type: 'null'
title: Working Description
done_description:
anyOf:
- type: object
propertyNames:
$ref: '#/components/schemas/MCPSupportedLanguage'
additionalProperties:
type: string
- type: 'null'
title: Done Description
title: TurbineToolLocale
TurbineToolMeta:
type: object
properties:
locale:
anyOf:
- $ref: '#/components/schemas/TurbineToolLocale'
- type: 'null'
tool_type:
anyOf:
- $ref: '#/components/schemas/ToolType'
- type: 'null'
timeout:
anyOf:
- type: number
- type: 'null'
title: Timeout
private_execution:
anyOf:
- type: boolean
- type: 'null'
title: Private Execution
title: TurbineToolMeta
securitySchemes:
ApiKey:
type: http
scheme: bearer
tags:
- name: chat
x-displayName: Chat
description: Chat Completion API.
- name: fim
x-displayName: FIM
description: Fill-in-the-middle API.
- name: agents
x-displayName: Agents
description: Agents API.
- name: embeddings
x-displayName: Embeddings
description: Embeddings API.
- name: classifiers
x-displayName: Classifiers
description: Classifiers API.
- name: files
x-displayName: Files
description: Files API
- name: deprecated.agents
x-displayName: (deprecated) Agents
description: (deprecated) Agents completion API
- name: deprecated.fine-tuning
x-displayName: (deprecated) Fine Tuning
description: (deprecated) Fine-tuning API
- name: models
x-displayName: Models
description: Model Management API
- name: batch
x-displayName: Batch
description: Batch API
- name: ocr
x-displayName: OCR API
description: OCR API
- name: audio.transcriptions
x-displayName: Transcriptions API
description: API for audio transcription.
- name: audio.speech
x-displayName: Speech API
description: API for text-to-speech generation.
- name: audio.voices
x-displayName: Voices API
description: API for managing custom voice profiles.
- name: beta.agents
x-displayName: (beta) Agents API
description: (beta) Agents API
- name: beta.conversations
x-displayName: (beta) Conversations API
description: (beta) Conversations API
- name: beta.libraries
x-displayName: (beta) Libraries API - Main
description: (beta) Libraries API to create and manage libraries - index your documents to enhance agent capabilities.
- name: beta.libraries.documents
x-displayName: (beta) Libraries API - Documents
description: (beta) Libraries API - manage documents in a library.
- name: beta.libraries.accesses
x-displayName: (beta) Libraries API - Access
description: (beta) Libraries API - manage access to a library.
- name: beta.observability.chat_completion_events
x-displayName: (beta) Observability - Chat completion events
description: (beta) Search, retrieve, and analyze chat completion events.
- name: beta.observability.chat_completion_events.fields
x-displayName: (beta) Observability - Chat completion fields
description: (beta) List and inspect filterable fields for chat completion events.
- name: beta.observability.judges
x-displayName: (beta) Observability - Judges
description: (beta) Create, update, and manage judges for evaluating chat completions.
- name: beta.observability.campaigns
x-displayName: (beta) Observability - Campaigns
description: (beta) Create and manage evaluation campaigns.
- name: beta.observability.datasets
x-displayName: (beta) Observability - Datasets
description: (beta) Create, update, import, and export datasets.
- name: beta.observability.datasets.records
x-displayName: (beta) Observability - Dataset records
description: (beta) Manage individual records within datasets.
- name: beta.workflows
x-displayName: Workflows
description: Workflow management API.
- name: beta.workflows.executions
x-displayName: Executions
description: Trigger, monitor, and control workflow executions.
- name: beta.workflows.runs
x-displayName: Runs
description: List and inspect individual workflow runs.
- name: beta.workflows.schedules
x-displayName: Schedules
description: Create and manage workflow schedules.
- name: beta.workflows.deployments
x-displayName: Deployments
description: List and inspect worker deployments.
- name: beta.workflows.events
x-displayName: Events
description: Stream and list workflow execution events.
- name: beta.workflows.metrics
x-displayName: Metrics
description: Get performance metrics for workflows.
- name: beta.workflows.workers
x-displayName: Workers
description: Worker connection info.
- name: beta.connectors
x-displayName: (beta) Connectors
description: (beta) Connectors
security:
- ApiKey: []
servers:
- url: https://api.mistral.ai
description: Production server