> ## Documentation Index
> Fetch the complete documentation index at: https://evolink.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# MiniMax-M3.1-Flash - API Responses
> - Appelle le modèle MiniMax-M3.1-Flash via le protocole OpenAI Responses
- **Formats d’entrée** : `input` peut contenir du texte brut ou un tableau d’éléments d’entrée (messages, appels de fonctions et résultats de fonctions)
- **Entrée multimodale** : combinez des blocs `input_text`, `input_image` et `input_video` dans le `content` d’un message
- **Instructions système** : transmises via `instructions`, ce qui équivaut à un message system placé en premier
- **Raisonnement** : toujours activé ; `reasoning.effort` règle sa profondeur. Le contenu du raisonnement est renvoyé sous forme d’éléments de sortie `reasoning`
- **Sortie en streaming** : événements SSE sémantiques, terminés par `response.completed` ; **`[DONE]` n’est pas envoyé**
- **Appels d’outils** : prise en charge du Function Calling
- **Cache de contexte** : les préfixes identiques sont automatiquement lus depuis le cache ; les tokens correspondants figurent dans `usage.input_tokens_details.cached_tokens`
**Sans état** : les réponses ne sont pas stockées et `previous_response_id` n’est pas pris en charge. À chaque tour, ajoutez à `input` tous les éléments du précédent `output`, dans leur ordre initial et en conservant tous leurs champs, notamment `content`, `summary` et `encrypted_content` des éléments de raisonnement. Après l’exécution d’un outil, ajoutez un élément `function_call_output` ayant le même `call_id` que l’appel de fonction.
**Événements de streaming** : `response.created`, `response.in_progress`, `response.output_item.added`, `response.content_part.added`, `response.reasoning_text.delta` / `response.reasoning_text.done`, `response.output_text.delta` / `response.output_text.done`, `response.content_part.done`, `response.output_item.done`. L’événement final est `response.completed`. Chaque événement contient un `sequence_number` pour l’ordonnancement.
**BaseURL** : la BaseURL par défaut est `https://direct.evolink.ai`, qui offre une meilleure prise en charge des modèles textuels et des connexions de longue durée. `https://api.evolink.ai` est le point de terminaison principal pour les services multimodaux et sert d'adresse de repli pour les modèles textuels.
## OpenAPI
````yaml fr/api-manual/language-series/minimax-m3.1-flash/minimax-m3.1-flash-responses.json POST /v1/responses
openapi: 3.1.0
info:
title: MiniMax-M3.1-Flash – Référence complète des paramètres (API Responses)
description: >-
Référence complète de l’API Responses de MiniMax-M3.1-Flash.
**Capacités du modèle** :
- Longueur du contexte : **1,000,000 tokens** (1M)
- Sortie maximale : **524,288 tokens** (512K), valeur recommandée :
**131,072 tokens** (128K), tokens de raisonnement inclus
- Raisonnement : toujours activé ; la profondeur se règle avec
`reasoning.effort`, dont la valeur par défaut est `max`
- Entrée multimodale : texte, images et vidéos
- Appels d’outils : prise en charge du Function Calling
- Cache de contexte : les préfixes identiques sont automatiquement lus
depuis le cache ; les tokens correspondants sont facturés au tarif de
lecture du cache
**Sans état** : les réponses ne sont pas conservées. Pour une conversation
multi-tours, le client doit transmettre l’historique complet à chaque
requête.
license:
name: MIT
version: 1.0.0
servers:
- url: https://direct.evolink.ai
description: Production (recommandée)
- url: https://api.evolink.ai
description: URL alternative
security:
- bearerAuth: []
tags:
- name: Génération de conversation
description: Points de terminaison liés à la génération de conversation par IA
paths:
/v1/responses:
post:
tags:
- Génération de conversation
summary: API Responses de MiniMax-M3.1-Flash (compatible OpenAI)
description: >-
- Appelle le modèle MiniMax-M3.1-Flash via le protocole OpenAI Responses
- **Formats d’entrée** : `input` peut contenir du texte brut ou un
tableau d’éléments d’entrée (messages, appels de fonctions et résultats
de fonctions)
- **Entrée multimodale** : combinez des blocs `input_text`,
`input_image` et `input_video` dans le `content` d’un message
- **Instructions système** : transmises via `instructions`, ce qui
équivaut à un message system placé en premier
- **Raisonnement** : toujours activé ; `reasoning.effort` règle sa
profondeur. Le contenu du raisonnement est renvoyé sous forme d’éléments
de sortie `reasoning`
- **Sortie en streaming** : événements SSE sémantiques, terminés par
`response.completed` ; **`[DONE]` n’est pas envoyé**
- **Appels d’outils** : prise en charge du Function Calling
- **Cache de contexte** : les préfixes identiques sont automatiquement
lus depuis le cache ; les tokens correspondants figurent dans
`usage.input_tokens_details.cached_tokens`
**Sans état** : les réponses ne sont pas stockées et
`previous_response_id` n’est pas pris en charge. À chaque tour, ajoutez
à `input` tous les éléments du précédent `output`, dans leur ordre
initial et en conservant tous leurs champs, notamment `content`,
`summary` et `encrypted_content` des éléments de raisonnement. Après
l’exécution d’un outil, ajoutez un élément `function_call_output` ayant
le même `call_id` que l’appel de fonction.
**Événements de streaming** : `response.created`,
`response.in_progress`, `response.output_item.added`,
`response.content_part.added`, `response.reasoning_text.delta` /
`response.reasoning_text.done`, `response.output_text.delta` /
`response.output_text.done`, `response.content_part.done`,
`response.output_item.done`. L’événement final est `response.completed`.
Chaque événement contient un `sequence_number` pour l’ordonnancement.
operationId: createResponseMiniMaxM31Flash
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ResponsesRequest'
examples:
simple_text:
summary: Conversation textuelle sur un seul tour
value:
model: MiniMax-M3.1-Flash
input: Explain recursion in one sentence.
max_output_tokens: 131072
with_instructions:
summary: Utilisation d'instructions système
value:
model: MiniMax-M3.1-Flash
instructions: >-
You are a technical documentation assistant. Keep your
answers concise.
input: Explain how context caching works.
max_output_tokens: 131072
multi_turn:
summary: Conversation multi-tours (tableau d'éléments d'entrée)
value:
model: MiniMax-M3.1-Flash
input:
- type: message
role: user
content: Suggest three names for a note-taking app.
- type: message
role: assistant
content: NoteFlow, ClearPage, QuickNote.
- type: message
role: user
content: Suggest five alternatives to the second name.
max_output_tokens: 131072
reasoning_effort:
summary: Régler la profondeur du raisonnement
value:
model: MiniMax-M3.1-Flash
input: >-
A bat and a ball cost 1.10 in total. The bat costs 1.00 more
than the ball. How much does the ball cost?
reasoning:
effort: high
max_output_tokens: 131072
vision_url:
summary: Compréhension d'image
value:
model: MiniMax-M3.1-Flash
input:
- type: message
role: user
content:
- type: input_text
text: Describe this image.
- type: input_image
image_url: https://example.com/photo.jpg
max_output_tokens: 131072
video_url:
summary: Compréhension vidéo
value:
model: MiniMax-M3.1-Flash
input:
- type: message
role: user
content:
- type: input_text
text: Summarize this video.
- type: input_video
video_url:
url: https://example.com/video.mp4
fps: 1
detail: default
max_output_tokens: 131072
function_calling:
summary: Function Calling (appel d'outil)
value:
model: MiniMax-M3.1-Flash
input: Check the stock for product demo-item-001.
tools:
- type: function
name: get_product_stock
description: Get the current stock level for a product.
parameters:
type: object
properties:
product_id:
type: string
description: Product identifier.
required:
- product_id
max_output_tokens: 131072
function_result:
summary: Transmettre le résultat d’un outil et poursuivre la réponse
value:
model: MiniMax-M3.1-Flash
reasoning:
effort: medium
max_output_tokens: 131072
input:
- type: message
role: user
content: >-
Use get_product_stock to check product demo-item-001.
After receiving the tool result, report whether it is in
stock and its quantity. Do not guess the stock level.
- id: 0725233e825de1d0656437967fc024e1_msg
type: message
status: completed
role: assistant
content:
- type: output_text
text: I'll check the stock level for that product now.
annotations: []
- id: 0725233e825de1d0656437967fc024e1_fc_0
type: function_call
status: completed
call_id: call_function_izs7qcnzfksd_1
name: get_product_stock
arguments: '{"product_id": "demo-item-001"}'
- type: function_call_output
call_id: call_function_izs7qcnzfksd_1
output: >-
{"product_id": "demo-item-001", "in_stock": true,
"quantity": 24}
tools:
- type: function
name: get_product_stock
description: Get the current stock level for a product.
parameters:
type: object
properties:
product_id:
type: string
description: Product identifier.
required:
- product_id
tool_choice: auto
streaming:
summary: Sortie en streaming
value:
model: MiniMax-M3.1-Flash
input: Write a short poem about autumn.
stream: true
max_output_tokens: 131072
reasoning_history:
summary: Poursuivre avec l’historique complet du raisonnement
value:
model: MiniMax-M3.1-Flash
reasoning:
effort: medium
max_output_tokens: 131072
input:
- type: message
role: user
content: >-
Find the smallest positive integer n such that n mod 7 =
3, n mod 11 = 5, and n mod 13 = 7. Return only n.
- id: 0725233a85e23431681447327cbcd9d2_rs
type: reasoning
status: completed
summary: []
content:
- type: reasoning_text
text: >-
We need solve CRT. Need only n. Compute. n=3 mod7, 5
mod11,7 mod13. Product 1001. Let's solve.
Use n=3+7a. mod11: 3+7a=5 =>7a=2 mod11. inverse7=8
(56=1), a=16=5 mod11. a=5+11b. n=38+77b. mod13:
38+77b = 12+12b mod13 (77=12,38=12) equals7
=>12b=-5=8 mod13. inverse12=12, b=96 mod13 =5? 91
remainder5. n=38+385=423. Check 423 mod7 3 (420),
mod11 5 (418), mod13 7 (416). Smallest positive 423.
Only n.
encrypted_content: >-
Ahlub3JtYWwtcmVhc29uaW5nLTIwMjYxMDExjehfvIf2rUinmic9ZiAutly0DD3lHqWEni9ENDziUw0nX-F6VPZLM7x1NbRWbytJNcLH9XQIa-KLYgd-it6XmXzYLvck3xOPOG9wtDdxUnjdBhuuj9dkWrkx0kbK8MFT5UreZ7EcxoRZybrs3oELf2BK_WtDUFOm_FbZXKwNbg76pTCFDoRke0Er0GMWjmi5L8GE7hGnvvBQjHXrwQ88G0L2p6STay-n1FJ5prqz6Q4LEF-xu7FqGjDmh9haliI638ivcQ9XGo9_DLUrtKMh1K4UYN87j2H7vbjbJPJaw6oJ61ZF8Ngk1FSuHUvLB540QKwBJKnClMcvw-ih3CdKRdSTPRfIYlsYOkNCwEWrLwHarLTHG5HzeakMO_5usxOAvzXVDUKRIX7W62x9xKCnVl_Gp0E91dLtlU3U8j_ZZvYCj9pMvd_n_Ba82OUpFxvoXv2R2H1H8bfzztGg5E88fH6OMwoMS5OYa45nCoRFA11Bw7G8OEVqBiPzS48EY1JPjPTC5lBco0CUoeUAHPXeD7jmO-D3LhIL1-3erJ_mxP0ZeiCWUckYaFE2EliolooAHqkoVBmy5Q
- id: 0725233a85e23431681447327cbcd9d2_msg
type: message
status: completed
role: assistant
content:
- type: output_text
text: '423'
annotations: []
- type: message
role: user
content: Add one to that result. Return only the new integer.
responses:
'200':
description: Génération réussie
content:
application/json:
schema:
$ref: '#/components/schemas/ResponsesResponse'
examples:
with_reasoning:
summary: Avec contenu de raisonnement
value:
id: 0725233a85e23431681447327cbcd9d2
object: response
created_at: 1792405562
model: MiniMax-M3.1-Flash
status: completed
output:
- id: 0725233a85e23431681447327cbcd9d2_rs
type: reasoning
status: completed
summary: []
content:
- type: reasoning_text
text: >-
We need solve CRT. Need only n. Compute. n=3 mod7,
5 mod11,7 mod13. Product 1001. Let's solve.
Use n=3+7a. mod11: 3+7a=5 =>7a=2 mod11. inverse7=8
(56=1), a=16=5 mod11. a=5+11b. n=38+77b. mod13:
38+77b = 12+12b mod13 (77=12,38=12) equals7
=>12b=-5=8 mod13. inverse12=12, b=96 mod13 =5? 91
remainder5. n=38+385=423. Check 423 mod7 3 (420),
mod11 5 (418), mod13 7 (416). Smallest positive
423. Only n.
encrypted_content: >-
Ahlub3JtYWwtcmVhc29uaW5nLTIwMjYxMDExjehfvIf2rUinmic9ZiAutly0DD3lHqWEni9ENDziUw0nX-F6VPZLM7x1NbRWbytJNcLH9XQIa-KLYgd-it6XmXzYLvck3xOPOG9wtDdxUnjdBhuuj9dkWrkx0kbK8MFT5UreZ7EcxoRZybrs3oELf2BK_WtDUFOm_FbZXKwNbg76pTCFDoRke0Er0GMWjmi5L8GE7hGnvvBQjHXrwQ88G0L2p6STay-n1FJ5prqz6Q4LEF-xu7FqGjDmh9haliI638ivcQ9XGo9_DLUrtKMh1K4UYN87j2H7vbjbJPJaw6oJ61ZF8Ngk1FSuHUvLB540QKwBJKnClMcvw-ih3CdKRdSTPRfIYlsYOkNCwEWrLwHarLTHG5HzeakMO_5usxOAvzXVDUKRIX7W62x9xKCnVl_Gp0E91dLtlU3U8j_ZZvYCj9pMvd_n_Ba82OUpFxvoXv2R2H1H8bfzztGg5E88fH6OMwoMS5OYa45nCoRFA11Bw7G8OEVqBiPzS48EY1JPjPTC5lBco0CUoeUAHPXeD7jmO-D3LhIL1-3erJ_mxP0ZeiCWUckYaFE2EliolooAHqkoVBmy5Q
- id: 0725233a85e23431681447327cbcd9d2_msg
type: message
status: completed
role: assistant
content:
- type: output_text
text: '423'
annotations: []
output_text: '423'
usage:
input_tokens: 239
output_tokens: 190
total_tokens: 429
input_tokens_details:
cached_tokens: 174
output_tokens_details:
reasoning_tokens: 189
error: null
incomplete_details: null
instructions: null
metadata: {}
tools: null
tool_choice: auto
temperature: 1
top_p: 0.95
text:
format:
type: text
reasoning:
effort: medium
summary: null
max_output_tokens: 2048
max_tool_calls: null
parallel_tool_calls: true
previous_response_id: null
conversation: null
store: false
service_tier: null
safety_identifier: null
truncation: disabled
function_call:
summary: Déclencher un appel d’outil
value:
id: 0725233e825de1d0656437967fc024e1
object: response
created_at: 1792405566
model: MiniMax-M3.1-Flash
status: completed
output:
- id: 0725233e825de1d0656437967fc024e1_msg
type: message
status: completed
role: assistant
content:
- type: output_text
text: I'll check the stock level for that product now.
annotations: []
- id: 0725233e825de1d0656437967fc024e1_fc_0
type: function_call
status: completed
call_id: call_function_izs7qcnzfksd_1
name: get_product_stock
arguments: '{"product_id": "demo-item-001"}'
output_text: I'll check the stock level for that product now.
usage:
input_tokens: 479
output_tokens: 43
total_tokens: 522
input_tokens_details:
cached_tokens: 174
error: null
incomplete_details: null
instructions: null
metadata: {}
tools:
- type: function
name: get_product_stock
description: Get the current stock level for a product.
parameters:
properties:
product_id:
description: Product identifier.
type: string
required:
- product_id
type: object
tool_choice: auto
temperature: 1
top_p: 0.95
text:
format:
type: text
reasoning:
effort: medium
summary: null
max_output_tokens: 2048
max_tool_calls: null
parallel_tool_calls: true
previous_response_id: null
conversation: null
store: false
service_tier: null
safety_identifier: null
truncation: disabled
incomplete:
summary: Limite de sortie atteinte (status=incomplete)
value:
id: 072514375f41347e5f4de3c6ceb8fd87
object: response
created_at: 1792401719
model: MiniMax-M3.1-Flash
status: incomplete
output:
- id: 072514375f41347e5f4de3c6ceb8fd87_rs
type: reasoning
status: completed
summary: []
content:
- type: reasoning_text
text: I need to explain the process step by step.
encrypted_content: >-
Ahlub3JtYWwtcmVhc29uaW5nLTIwMjYxMDExv21cbZ66-fbVryqevLX4LJWxZguAnQBWN1xlN33KB5qCPkM8IMN2pVWWIclGFlVn6ZZ0CBzkPpHqkdCVqpYbDWc3gQl2Qmf0uD4s3wo
output_text: null
usage:
input_tokens: 211
output_tokens: 8
total_tokens: 219
input_tokens_details:
cached_tokens: 195
output_tokens_details:
reasoning_tokens: 8
error: null
incomplete_details:
reason: max_output_tokens
instructions: null
metadata: {}
tools: null
tool_choice: auto
temperature: 1
top_p: 0.95
text:
format:
type: text
reasoning:
effort: max
summary: null
max_output_tokens: 8
max_tool_calls: null
parallel_tool_calls: true
previous_response_id: null
conversation: null
store: false
service_tier: null
safety_identifier: null
truncation: disabled
'400':
description: Paramètres de requête invalides
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: invalid_prompt
message: Invalid request parameters
type: invalid_request_error
'401':
description: Non authentifié, jeton invalide ou expiré
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 401
message: Invalid authentication credentials
type: authentication_error
'402':
description: Quota insuffisant, recharge requise
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 402
message: Insufficient quota
type: insufficient_quota
'403':
description: Accès refusé pour ce modèle
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 403
message: Model access denied
type: permission_error
'404':
description: Ressource introuvable
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 404
message: Model not found
type: not_found_error
'413':
description: Corps de requête trop volumineux
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 413
message: Request entity too large
type: invalid_request_error
'429':
description: Limite de fréquence dépassée
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 429
message: Rate limit exceeded
type: rate_limit_error
'500':
description: Erreur interne du serveur
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 500
message: Internal server error
type: server_error
'502':
description: Passerelle incorrecte
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 502
message: Bad gateway
type: server_error
'503':
description: Service temporairement indisponible
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: 503
message: Service temporarily unavailable
type: server_error
components:
schemas:
ResponsesRequest:
type: object
required:
- model
- input
properties:
model:
type: string
description: ID du modèle
enum:
- MiniMax-M3.1-Flash
example: MiniMax-M3.1-Flash
input:
type:
- string
- array
description: >-
Entrée du modèle
- **Chaîne** : le texte entier est traité comme un message `user`
- **Tableau** : liste d’éléments d’entrée ; prend en charge
`message`, `function_call`, `function_call_output` et `reasoning`
**Multimodal** : combinez des blocs `input_text`, `input_image` et
`input_video` dans le tableau `content` d’un élément `message`.
**Conversations multi-tours** : l’API est sans état. Pour poursuivre
une conversation, le tableau doit contenir l’historique complet.
items:
$ref: '#/components/schemas/InputItem'
example: Explain recursion in one sentence.
instructions:
type: string
description: >-
Instructions de niveau système, équivalentes à un message system
inséré tout au début ; sert à définir le rôle, le ton et les
contraintes de sortie.
example: >-
You are a technical documentation assistant. Keep your answers
concise.
stream:
type: boolean
description: >-
Indique si la réponse est renvoyée en streaming
- `false` (par défaut) : renvoie l’objet de réponse complet en une
seule fois
- `true` : transmet des événements SSE sémantiques ; l’événement
final est `response.completed`. **`[DONE]` n’est pas envoyé**
default: false
example: false
max_output_tokens:
type: integer
description: >-
Nombre maximal de tokens de sortie pour cette génération,
**raisonnement et réponse inclus**
- Valeur recommandée : **131,072** (128K), maximum : **524,288**
(512K)
- Une valeur trop faible peut atteindre la limite pendant le
raisonnement. Dans ce cas, la réponse contient `status:
"incomplete"` sans élément de sortie `message`
minimum: 1
maximum: 524288
example: 131072
reasoning:
type: object
description: >-
Configuration du raisonnement. MiniMax-M3.1-Flash effectue toujours
un raisonnement. Son contenu est renvoyé sous forme d’éléments de
sortie `reasoning` ; les tokens correspondants sont comptabilisés
dans la sortie et facturés au tarif de sortie.
properties:
effort:
type: string
description: >-
Profondeur du raisonnement, valeur par défaut : `max`. Les
niveaux plus élevés augmentent généralement la consommation de
tokens de raisonnement et le temps de réponse.
enum:
- low
- medium
- high
- xhigh
- max
default: max
example: high
temperature:
type: number
description: Température d’échantillonnage, fixée à `1`
enum:
- 1
default: 1
example: 1
top_p:
type: number
description: 'Seuil d’échantillonnage par noyau, valeur par défaut : 0.95.'
minimum: 0
maximum: 1
default: 0.95
example: 0.95
tools:
type: array
description: >-
Liste des outils que le modèle peut appeler. Seul le type `function`
est actuellement pris en charge. Les fonctions sont exécutées par le
client, qui transmet leurs résultats sous forme d’éléments d’entrée
`function_call_output`.
items:
$ref: '#/components/schemas/Tool'
tool_choice:
type: string
description: >-
Stratégie de sélection des outils. Seule la valeur `auto` est prise
en charge ; le modèle décide s’il doit appeler un outil
enum:
- auto
default: auto
example: auto
text:
type: object
description: >-
Configuration du format de sortie textuelle. Seule la valeur `text`
est prise en charge pour `format.type`
properties:
format:
type: object
properties:
type:
type: string
enum:
- text
default: text
description: Type de format de sortie
metadata:
type: object
description: >-
Métadonnées de la requête, dont les clés et les valeurs sont des
chaînes
additionalProperties:
type: string
ResponsesResponse:
type: object
description: >-
Objet de réponse de l’API Responses. Outre les champs ci-dessous, la
réponse reprend la configuration de la requête (`tools`, `tool_choice`,
`temperature`, `top_p`, `text`, `reasoning`, `max_output_tokens`, etc.).
properties:
id:
type: string
description: Identifiant unique de cette réponse
example: 072514d63605b7a0c83f1672230c398c
object:
type: string
description: Type d'objet, toujours `response`
example: response
created_at:
type: integer
description: Date de création sous forme d'horodatage Unix (secondes)
example: 1792401878
status:
type: string
description: >-
Statut de la réponse
- `completed` : traitement terminé normalement
- `incomplete` : sortie tronquée ; voir la cause dans
`incomplete_details`
- `failed` : échec de la génération ; voir la cause dans `error`
enum:
- completed
- incomplete
- failed
example: completed
model:
type: string
description: ID du modèle ayant réellement produit cette réponse
example: MiniMax-M3.1-Flash
output:
type: array
description: >-
Liste des éléments de sortie dans l’ordre de leur génération :
- `reasoning` : processus de raisonnement, avec un ID au format
`_rs` ; contient `content` (liste de blocs `reasoning_text`),
`summary` (tableau vide) et `encrypted_content`
- `message` : réponse finale, avec un ID au format `_msg` ;
contient `content` (liste de blocs `output_text`)
- `function_call` : appel de fonction généré par le modèle, avec un
ID au format `_fc_` ; contient `call_id`, `name` et
`arguments`. Le client doit exécuter la fonction et transmettre le
résultat dans un élément `function_call_output`
items:
type: object
output_text:
type:
- string
- 'null'
description: >-
Champ pratique contenant la concaténation de tous les textes
`output_text` ; vaut `null` en l’absence de sortie textuelle
error:
type:
- object
- 'null'
description: Motif de l'échec ; `null` en cas de succès
incomplete_details:
type:
- object
- 'null'
description: >-
Cause de la troncature ; vaut `null` si la sortie n’est pas
tronquée. `reason` vaut `max_output_tokens` (limite de sortie
atteinte) ou `content_filter` (sécurité du contenu)
usage:
$ref: '#/components/schemas/Usage'
ErrorResponse:
type: object
description: Réponse d'erreur
properties:
error:
type: object
properties:
code:
type:
- integer
- string
- 'null'
description: Code d’erreur
example: invalid_prompt
message:
type: string
description: Description de l'erreur
example: Invalid request parameters
type:
type: string
description: Type d'erreur
example: invalid_request_error
InputItem:
title: Élément d'entrée
description: >-
Élément d’entrée : message, historique de raisonnement, appel de
fonction ou résultat de fonction.
oneOf:
- $ref: '#/components/schemas/MessageItem'
- $ref: '#/components/schemas/ReasoningItem'
- $ref: '#/components/schemas/FunctionCallItem'
- $ref: '#/components/schemas/FunctionCallOutputItem'
Tool:
type: object
title: Définition d'outil
required:
- type
- name
properties:
type:
type: string
description: Type d’outil ; seul `function` est actuellement pris en charge
enum:
- function
example: function
name:
type: string
description: Nom de la fonction
example: get_product_stock
description:
type: string
description: >-
Description de la fonction. Une description claire aide le modèle à
déterminer quand l’appeler.
example: Get the current stock level for a product.
parameters:
type: object
description: Définition des paramètres au format JSON Schema.
example:
type: object
properties:
product_id:
type: string
description: Product identifier.
required:
- product_id
Usage:
type: object
description: >-
Statistiques d’utilisation des tokens, avec le détail du cache et du
raisonnement
properties:
input_tokens:
type: integer
description: >-
Nombre total de tokens d’entrée, y compris les tokens lus depuis le
cache
example: 207
input_tokens_details:
type: object
description: Détail des tokens d'entrée
properties:
cached_tokens:
type: integer
description: >-
Nombre de tokens d’entrée lus depuis le cache
Les tokens lus depuis le cache sont facturés au tarif de lecture
du cache. Tokens non mis en cache = `input_tokens -
cached_tokens` ; ils sont facturés au tarif d’entrée standard
example: 174
output_tokens:
type: integer
description: Nombre de tokens de sortie (part de réflexion incluse)
example: 32
output_tokens_details:
type: object
description: Détail des tokens de sortie
properties:
reasoning_tokens:
type: integer
description: >-
Nombre de tokens de raisonnement (déjà inclus dans
`output_tokens`)
example: 9
total_tokens:
type: integer
description: Nombre total de tokens = input_tokens + output_tokens
example: 239
MessageItem:
type: object
title: Élément de message
description: >-
Message de la conversation. Conservez tous les champs renvoyés lors de
la transmission de l’historique de l’assistant.
required:
- role
- content
properties:
type:
type: string
enum:
- message
default: message
id:
type: string
description: Identifiant de l’élément de sortie. Conservez-le dans l’historique.
status:
type: string
description: Statut de l’élément de sortie. Conservez-le dans l’historique.
role:
type: string
description: >-
Rôle du message, utilisé uniquement avec `type: message`.
`developer` est traité comme `system`.
enum:
- user
- assistant
- system
- developer
example: user
content:
type:
- string
- array
description: >-
Contenu du message, utilisé uniquement avec `type: message`. Peut
être du texte brut ou un tableau de blocs de contenu.
**Types de blocs de contenu** :
- `input_text` : texte dans le champ `text`
- `input_image` : image dans le champ `image_url`
- `input_video` : vidéo dans le champ `video_url`
- `output_text` : texte d’une réponse assistant précédente
Taille maximale du corps de la requête : 64 MB.
items:
$ref: '#/components/schemas/ContentPart'
example: Explain recursion in one sentence.
ReasoningItem:
type: object
title: Élément de raisonnement
description: >-
Raisonnement renvoyé au tour précédent. Pour poursuivre la conversation,
conservez l’élément complet, notamment `id`, `status`, `summary`,
`content` et `encrypted_content`.
required:
- type
properties:
type:
type: string
enum:
- reasoning
id:
type: string
description: Identifiant de l’élément de sortie. Conservez-le dans l’historique.
status:
type: string
description: Statut de l’élément de sortie. Conservez-le dans l’historique.
summary:
type: array
description: >-
Résumé du raisonnement. À conserver tel quel lors de la transmission
de l’historique de la conversation.
items:
type: object
content:
type: array
description: Blocs de raisonnement. Conservez-les tels quels dans l’historique.
items:
$ref: '#/components/schemas/ReasoningContentPart'
encrypted_content:
type: string
description: >-
Données opaques de raisonnement. Conservez-les telles quelles dans
l’historique.
FunctionCallItem:
type: object
title: Appel de fonction
description: >-
Appel de fonction renvoyé par le modèle, associé à un élément
`function_call_output` par `call_id`.
required:
- type
- call_id
- name
- arguments
properties:
type:
type: string
enum:
- function_call
id:
type: string
description: Identifiant de l’élément de sortie. Conservez-le dans l’historique.
status:
type: string
description: Statut de l’élément de sortie. Conservez-le dans l’historique.
call_id:
type: string
description: >-
Identifiant d'appel de fonction ; `function_call` et
`function_call_output` sont appariés grâce à lui.
name:
type: string
description: >-
Nom de la fonction appelée, utilisé uniquement avec `type:
function_call`.
arguments:
type: string
description: >-
Arguments de l'appel de fonction sous forme de chaîne JSON, utilisés
uniquement avec `type: function_call`.
FunctionCallOutputItem:
type: object
title: Résultat de fonction
description: >-
Résultat d’une fonction exécutée par le client, associé à son appel par
`call_id`.
required:
- type
- call_id
- output
properties:
type:
type: string
enum:
- function_call_output
call_id:
type: string
description: >-
Identifiant d'appel de fonction ; `function_call` et
`function_call_output` sont appariés grâce à lui.
output:
type: string
description: >-
Résultat de l'exécution de la fonction, utilisé uniquement avec
`type: function_call_output`.
ContentPart:
type: object
title: Bloc de contenu
required:
- type
properties:
type:
type: string
enum:
- input_text
- input_image
- input_video
- output_text
description: Type de bloc de contenu
text:
type: string
description: Contenu textuel (`input_text` / `output_text`)
image_url:
description: >-
Entrée d’image, utilisée avec `type: input_image`. Transmettez
directement une URL / URL de données Base64 sous forme de chaîne, ou
un objet `{"url": "...", "detail": "low | default | high"}` pour
régler la précision d’analyse (une précision plus élevée permet de
mieux distinguer les détails et consomme plus de tokens). Formats
pris en charge : JPEG / PNG / GIF / WEBP, maximum 10 MB par image
oneOf:
- type: string
- type: object
required:
- url
properties:
url:
type: string
description: URL d’image ou URL de données Base64
detail:
type: string
enum:
- low
- default
- high
default: default
description: Précision d’analyse
video_url:
description: >-
Entrée vidéo, utilisée avec `type: input_video`. Transmettez
directement une URL / URL de données Base64 sous forme de chaîne, ou
un objet `{"url": "...", "fps": 1, "detail": "default",
"max_long_side_pixel": ...}`. `fps` est la fréquence
d’échantillonnage des images vidéo, avec une valeur par défaut de 1
et une plage de [0.2, 5]. Une valeur plus faible consomme moins de
tokens. Formats pris en charge : MP4 / AVI / MOV / MKV, maximum 50
MB pour une entrée URL / Base64. Les vidéos plus volumineuses sont
transmises via une référence de fichier `mm_file://{file_id}`
oneOf:
- type: string
- type: object
required:
- url
properties:
url:
type: string
description: URL vidéo, URL de données Base64 ou `mm_file://{file_id}`
fps:
type: number
minimum: 0.2
maximum: 5
default: 1
description: Fréquence d’échantillonnage des images vidéo
detail:
type: string
enum:
- low
- default
- high
default: default
description: Précision d’analyse
max_long_side_pixel:
type: integer
minimum: 1
description: Limite de pixels du côté le plus long des images vidéo
ReasoningContentPart:
type: object
title: Bloc de raisonnement
required:
- type
- text
properties:
type:
type: string
enum:
- reasoning_text
text:
type: string
description: Texte du raisonnement.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
Toutes les API nécessitent une authentification Bearer Token
**Obtenir une clé API** :
Visitez la [Page de gestion des clés
API](https://evolink.ai/dashboard/keys) pour obtenir votre clé API
**Ajouter à l'en-tête de requête** :
```
Authorization: Bearer YOUR_API_KEY
```
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.