{"openapi":"3.0.0","info":{"description":"Open source language models","version":[{"name":"v1","value":"v1"}]},"servers":[{"description":"Open source language models","url":"https://api.apirails.com/mistralai"}],"paths":{"/v1/fim/completions":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/createChatCompletion","api_endpoint":"https://api.mistral.ai/v1/fim/completions"},"summary":"Create FIM Completions","description":"Create FIM Completions","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"max_tokens":{"type":"number","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"},"min_tokens":{"type":"number","description":"The minimum number of tokens to generate in the completion."},"model":{"type":"string","description":"ID of the model to use."},"prompt":{"type":"string","description":"The text/code to complete","required":true},"random_seed":{"type":"number","description":"The seed to use for random sampling. If set, different calls will generate deterministic results"},"stop":{"type":"array","description":"Stop generation if this token is detected","items":{"type":"string"}},"stream":{"type":"boolean","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..","enum":[true,false]},"suffix":{"type":"string","description":"Optional text/code that adds more context for the model"},"temperature":{"type":"number","description":"Default: 0.7 What sampling temperature to use, between 0.0 and 1.0. Higher values like 0.8 will make the outptu more random, while lower values like 0.2 will make it more focused and deterministic."},"top_p":{"type":"number","description":"Nucleus sampling, where the model considers the results of the tokens with with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered."}}},"example":{"max_tokens":"","min_tokens":"","model":"","prompt":"","random_seed":"","stop":["\n"," STOP"],"stream":"","suffix":"","temperature":"","top_p":""}}}}}},"/v1/chat/completions":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/createChatCompletion","api_endpoint":"https://api.mistral.ai/v1/chat/completions"},"summary":"Create Chat Completions","description":"Create Chat Completions","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"max_tokens":{"type":"number","description":"Default: null. The maximum number of tokens to generate in the completion."},"messages":{"type":"array","description":"The prompt(s) to generate completions for, encoded as a list of dict with role and content","required":true,"items":{"type":"object","properties":{"role":{"type":"string","description":"Role of the message sender","required":true,"enum":["system","user","assistant","tool"]},"content":{"type":"string","description":"Content of the message. Can be a plain string or an array of content blocks for multimodal input","required":true}}}},"model":{"type":"string","description":"ID of the model to use. You can use the List Available Models API to see all of your available models, or see our Model overview for model descriptions.","required":true},"random_seed":{"type":"number","description":"The seed to use for random sampling. If set, different calls will generate deterministic results."},"safe_prompt":{"type":"boolean","description":"Default: false","enum":[true,false]},"stream":{"type":"boolean","description":"Default: false","enum":[true,false]},"temperature":{"type":"number","description":"Default: 0.7"},"top_p":{"type":"number","description":"Default: 1"}}},"example":{"max_tokens":"","messages":[{"role":"user","content":"What is the capital of France?"}],"model":"","random_seed":"","safe_prompt":"","stream":"","temperature":"","top_p":""}}}}}},"/v1/embeddings":{"post":{"tags":["Embeddings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/createEmbedding","api_endpoint":"https://api.mistral.ai/v1/embeddings"},"summary":"Create Embeddings","description":"Create Embeddings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"encoding_format":{"type":"string","description":"The format of the output data","required":true},"input":{"type":"array","description":"Text to embed. Can be a string or a list of strings","required":true,"items":{"type":"string"}},"model":{"type":"string","description":"The ID of the model to use for this request","required":true}}},"example":{"encoding_format":"","input":[["Embed this sentence.","As well as this one."]],"model":""}}}}}},"/v1/files":{"get":{"tags":["Files"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/files_api_routes_list_files","api_endpoint":"https://api.mistral.ai/v1/files"},"summary":"List Files","description":"Returns a list of files that belong to the user's organization","security":[{"bearerAuth":[]}]},"post":{"tags":["Files"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/files_api_routes_upload_file","api_endpoint":"https://api.mistral.ai/v1/files"},"summary":"Upload File","description":"Upload a file that can be used across various endpoints\nThe size of individual files can be a maximum of 512 MB The Fine-tuning API only supports .jsonl files","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","format":"binary","description":"The File object (not file name) to be uploaded","required":true},"purpose":{"type":"string","description":"The intended purpose of the uploaded file","required":true}}},"example":{"file":"(binary)","purpose":""}}}}}},"/v1/files/{file_id}":{"get":{"tags":["Files"],"parameters":[{"name":"file_id","in":"path","description":"The ID of the file to use for this request","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/files_api_routes_retrieve_file","api_endpoint":"https://api.mistral.ai/v1/files/{file_id}"},"summary":"Retrieve File","description":"Returns information about a specific file","security":[{"bearerAuth":[]}]},"delete":{"tags":["Files"],"parameters":[{"name":"file_id","in":"path","description":"The ID of the file to use for this request","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/files_api_routes_delete_file","api_endpoint":"https://api.mistral.ai/v1/files/{file_id}"},"summary":"Delete File","description":"Delete a file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/files/{file_id}/content":{"get":{"tags":["Files"],"parameters":[{"name":"file_id","in":"path","description":"The ID of the file to download","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/files_api_routes_download_file","api_endpoint":"https://api.mistral.ai/v1/files/{file_id}/content"},"summary":"Download File","description":"Download a file","security":[{"bearerAuth":[]}]}},"/v1/files/{file_id}/url":{"get":{"tags":["Files"],"parameters":[{"name":"file_id","in":"path","description":"The ID of the file to get a signed URL for","required":true,"schema":{"type":"string","example":""}},{"name":"expiry","in":"query","description":"Number of hours before the url becomes invalid. Defaults to 24h","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/files_api_routes_get_signed_url","api_endpoint":"https://api.mistral.ai/v1/files/{file_id}/url"},"summary":"Get Signed Url","description":"Get a signed URL for a file","security":[{"bearerAuth":[]}]}},"/v1/fine_tuning/jobs":{"get":{"tags":["Fine Tuning"],"parameters":[{"name":"created_after","in":"query","description":"The date/time to filter on. When set, the results for previous creation times are not displayed.","schema":{"type":"string","example":""}},{"name":"created_by_me","in":"query","description":"Default: false When set, only return results for jobs created by the API caller. Other results are not displayed.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"model","in":"query","description":"The model name used for fine-tuning to filter on. When set, the other results are not displayed","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Default: 0. The page number of the results to be returned","schema":{"type":"number","example":""}},{"name":"page_size","in":"query","description":" Default: 100. The number of items to return per page","required":true,"schema":{"type":"number","example":""}},{"name":"status","in":"query","description":"The current job state to filter on. When set, the other results are not displayed","schema":{"type":"string","example":"","items":{"type":"string","enum":["QUEUED","STARTED","RUNNING","FAILED","SUCCESS","CANCELLED","CANCELLATION_REQUESTED"]}}},{"name":"suffix","in":"query","description":"The model suffix to filter on. When set, the other results are not displayed.","schema":{"type":"string","example":""}},{"name":"wandb_name","in":"query","description":"The Weight and Biases run name to filter on. When set, the other results are not displayed.","schema":{"type":"string","example":""}},{"name":"wandb_project","in":"query","description":"The Weights and Biases project to filter on. When set, the other results are not displayed.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/jobs_api_routes_fine_tuning_get_fine_tuning_jobs","api_endpoint":"https://api.mistral.ai/v1/fine_tuning/jobs"},"summary":"List Fine Tuning Jobs","description":"Get a list of fine tuning jobs for your organization and user","security":[{"bearerAuth":[]}]},"post":{"tags":["Fine Tuning"],"parameters":[{"name":"dry_run","in":"query","description":"Default: false","required":true,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/jobs_api_routes_fine_tuning_create_fine_tuning_job","api_endpoint":"https://api.mistral.ai/v1/fine_tuning/jobs"},"summary":"Create Fine Tuning Job","description":"Create a new fine tuning job, it will be queued for processing","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"hyperparameters":{"type":"object","description":"The fine-tuning hyperparameter settings used in a fine-tune job.","properties":{"training_steps":{"type":"number","description":"The number of training steps to run"},"learning_rate":{"type":"number","description":"The learning rate to use for training"},"batch_size":{"type":"number","description":"The batch size to use for training"},"epochs":{"type":"number","description":"The number of epochs to train for"}}},"integrations":{"type":"array","description":"A list of integrations to enable for your fine-tuning job","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of integration","required":true,"enum":["wandb"]},"project":{"type":"string","description":"The project name for the integration"},"name":{"type":"string","description":"The run name for the integration"}}}},"model":{"type":"string","description":"The name of the model to fine-tune","required":true,"enum":["open-mistral-7b","mistral-small-latest"]},"suffix":{"type":"string","description":"A string that will be added to your fine-tuning model name."},"training_files":{"type":"array","description":"A list containing the IDs of uploaded files that contain training data","required":true,"items":{"type":"object","properties":{"file_id":{"type":"string","description":"The ID of the uploaded file containing training data","required":true},"percentage":{"type":"number","description":"The percentage of the file to use for training (0-100)"}}}},"validation_files":{"type":"array","description":"A list containing the IDs of uploaded files that contain validation data.","items":{"type":"string"}}}},"example":{"hyperparameters":{},"integrations":[],"model":"","suffix":"","training_files":[],"validation_files":["file-id-1","file-id-2"]}}}}}},"/v1/fine_tuning/jobs/{job_id}/cancel":{"post":{"tags":["Fine Tuning"],"parameters":[{"name":"job_id","in":"path","description":"Job Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/jobs_api_routes_fine_tuning_cancel_fine_tuning_job","api_endpoint":"https://api.mistral.ai/v1/fine_tuning/jobs/{job_id}/cancel"},"summary":"Cancel Fine Tuning Job","description":"Request the cancellation of a fine tuning job","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/fine_tuning/jobs/{job_id}/start":{"post":{"tags":["Fine Tuning"],"parameters":[{"name":"job_id","in":"path","description":"The ID of the job to start","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/jobs_api_routes_fine_tuning_start_fine_tuning_job","api_endpoint":"https://api.mistral.ai/v1/fine_tuning/jobs/{job_id}/start"},"summary":"Start Fine Tuning Job","description":"Request the start of a validated fine tuning job","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/fine_tuning/jobs/{job_id}":{"get":{"tags":["Fine Tuning"],"parameters":[{"name":"job_id","in":"path","description":"The ID of the job to analyse.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/jobs_api_routes_fine_tuning_get_fine_tuning_job","api_endpoint":"https://api.mistral.ai/v1/fine_tuning/jobs/{job_id}"},"summary":"Get Fine Tuning Job","description":"Get a fine tuned job details by its UUID","security":[{"bearerAuth":[]}]}},"/v1/fine_tuning/models/{model_id}":{"patch":{"tags":["Fine Tuning"],"parameters":[{"name":"model_id","in":"path","description":"The ID of the model to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/jobs_api_routes_fine_tuning_update_fine_tuned_model","api_endpoint":"https://api.mistral.ai/v1/fine_tuning/models/{model_id}"},"summary":"Update Fine Tuned Model","description":"Update a model name or description","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The description of the model"},"name":{"type":"string","description":"The name of the model"}}},"example":{"description":"","name":""}}}}}},"/v1/fine_tuning/models/{model_id}/archive":{"post":{"tags":["Fine Tuning"],"parameters":[{"name":"model_id","in":"path","description":"The ID of the model to archive","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/jobs_api_routes_fine_tuning_archive_fine_tuned_model","api_endpoint":"https://api.mistral.ai/v1/fine_tuning/models/{model_id}/archive"},"summary":"Archive Fine Tuned Model","description":"Archive a fine-tuned model","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Fine Tuning"],"parameters":[{"name":"model_id","in":"path","description":"The ID of the model to unarchive","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/jobs_api_routes_fine_tuning_unarchive_fine_tuned_model","api_endpoint":"https://api.mistral.ai/v1/fine_tuning/models/{model_id}/archive"},"summary":"Unarchive Fine Tuned Model","description":"Un-archive a fine-tuned model","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/models":{"get":{"tags":["Models"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/listModels","api_endpoint":"https://api.mistral.ai/v1/models"},"summary":"List Available Models","description":"List Available Models","security":[{"bearerAuth":[]}]}},"/v1/models/{model_id}":{"get":{"tags":["Models"],"parameters":[{"name":"model_id","in":"path","description":"The ID of the model to retrieve","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/retrieve_model_v1_models__model_id__get","api_endpoint":"https://api.mistral.ai/v1/models/{model_id}"},"summary":"Retrieve Model","description":"Retrieve information about a model","security":[{"bearerAuth":[]}]},"delete":{"tags":["Models"],"parameters":[{"name":"model_id","in":"path","description":"The ID of the model to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/delete_model_v1_models__model_id__delete","api_endpoint":"https://api.mistral.ai/v1/models/{model_id}"},"summary":"Delete Model","description":"Delete a fine-tuned model","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/batch/jobs":{"post":{"tags":["Batch"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/jobs_api_routes_batch_create_batch_job","api_endpoint":"https://api.mistral.ai/v1/batch/jobs"},"summary":"Create Batch Job","description":"Create a new batch job, it will be queued for processing","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"requests":{"type":"array","description":"Array of requests to batch process","required":true,"items":{"type":"object","properties":{"custom_id":{"type":"string","description":"Developer-provided ID for each request. Must be unique within the batch"},"body":{"type":"object","description":"The request body for the endpoint being called","required":true},"endpoint":{"type":"string","description":"The API endpoint to call (e.g. /v1/chat/completions, /v1/embeddings)","required":true}}}}}},"example":{"requests":[]}}}}},"get":{"tags":["Batch"],"parameters":[{"name":"agent_id","in":"query","description":"The agent ID used for batch processing to filter on","schema":{"type":"string","example":""}},{"name":"created_after","in":"query","description":"The date/time to filter on. When set, the results for previous creation times are not displayed","schema":{"type":"string","example":""}},{"name":"metadata","in":"query","description":"Metadata filter for batch jobs","schema":{"type":"object","example":""}},{"name":"model","in":"query","description":"The model name used for batch processing to filter on","schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Default: 0. The page number of the results to be returned","schema":{"type":"number","example":""}},{"name":"page_size","in":"query","description":"Default: 100. The number of items to return per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/jobs_api_routes_batch_get_batch_jobs","api_endpoint":"https://api.mistral.ai/v1/batch/jobs"},"summary":"Get Batch Jobs","description":"Get a list of batch jobs for your organization and user","security":[{"bearerAuth":[]}]}},"/v1/batch/jobs/{job_id}":{"get":{"tags":["Batch"],"parameters":[{"name":"job_id","in":"path","description":"The ID of the batch job to retrieve","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/jobs_api_routes_batch_get_batch_job","api_endpoint":"https://api.mistral.ai/v1/batch/jobs/{job_id}"},"summary":"Get Batch Job","description":"Get a batch job details by its UUID","security":[{"bearerAuth":[]}]}},"/v1/batch/jobs/{job_id}/cancel":{"post":{"tags":["Batch"],"parameters":[{"name":"job_id","in":"path","description":"The ID of the batch job to cancel","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/jobs_api_routes_batch_cancel_batch_job","api_endpoint":"https://api.mistral.ai/v1/batch/jobs/{job_id}/cancel"},"summary":"Cancel Batch Job","description":"Request the cancellation of a batch job","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/agents":{"post":{"tags":["Agents"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_agents_create","api_endpoint":"https://api.mistral.ai/v1/agents"},"summary":"Create Agent","description":"Create a agent that can be used within a conversation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The description of the agent"},"instructions":{"type":"string","description":"The instructions for the agent","required":true},"model":{"type":"string","description":"The model to use for the agent"},"name":{"type":"string","description":"The name of the agent","required":true},"tools":{"type":"array","description":"The tools available to the agent","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of tool","required":true,"enum":["function","web_search","web_search_premium","code_interpreter","image_generation","document_library","connector"]},"function":{"type":"object","description":"The function definition for a function-type tool"}}}}}},"example":{"description":"","instructions":"","model":"","name":"","tools":[{"type":"function","function":{"name":"get_weather","description":"Get the current weather","parameters":{"type":"object","properties":{"location":{"type":"string"}}}}}]}}}}},"get":{"tags":["Agents"],"parameters":[{"name":"page","in":"query","description":"Default: 0. The page number of the results to be returned","schema":{"type":"number","example":""}},{"name":"page_size","in":"query","description":"Default: 100. The number of items to return per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_agents_list","api_endpoint":"https://api.mistral.ai/v1/agents"},"summary":"List Agents","description":"Retrieve a list of agent entities sorted by creation time","security":[{"bearerAuth":[]}]}},"/v1/agents/{agent_id}":{"get":{"tags":["Agents"],"parameters":[{"name":"agent_id","in":"path","description":"The ID of the agent to retrieve","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_agents_get","api_endpoint":"https://api.mistral.ai/v1/agents/{agent_id}"},"summary":"Get Agent","description":"Retrieve an agent entity by its ID","security":[{"bearerAuth":[]}]},"patch":{"tags":["Agents"],"parameters":[{"name":"agent_id","in":"path","description":"The ID of the agent to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_agents_update","api_endpoint":"https://api.mistral.ai/v1/agents/{agent_id}"},"summary":"Update Agent","description":"Update an agent entity","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The description of the agent"},"instructions":{"type":"string","description":"The instructions for the agent"},"model":{"type":"string","description":"The model to use for the agent"},"name":{"type":"string","description":"The name of the agent"},"tools":{"type":"array","description":"The tools available to the agent","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of tool","required":true,"enum":["function","web_search","web_search_premium","code_interpreter","image_generation","document_library","connector"]},"function":{"type":"object","description":"The function definition for a function-type tool"}}}}}},"example":{"description":"","instructions":"","model":"","name":"","tools":[{"type":"function","function":{"name":"get_weather","description":"Get the current weather","parameters":{"type":"object","properties":{"location":{"type":"string"}}}}}]}}}}},"delete":{"tags":["Agents"],"parameters":[{"name":"agent_id","in":"path","description":"The ID of the agent to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_agents_delete","api_endpoint":"https://api.mistral.ai/v1/agents/{agent_id}"},"summary":"Delete Agent","description":"Delete an agent entity","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/agents/{agent_id}/version":{"patch":{"tags":["Agents"],"parameters":[{"name":"agent_id","in":"path","description":"The ID of the agent","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_agents_version","api_endpoint":"https://api.mistral.ai/v1/agents/{agent_id}/version"},"summary":"Update Agent Version","description":"Update an agent version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"version":{"type":"string","description":"The version to update to","required":true}}},"example":{"version":""}}}}}},"/v1/agents/completions":{"post":{"tags":["Agents"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_agents_completions","api_endpoint":"https://api.mistral.ai/v1/agents/completions"},"summary":"Create Agent Completion","description":"Create a completion using an agent","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"agent_id":{"type":"string","description":"The ID of the agent to use","required":true},"messages":{"type":"array","description":"The prompt(s) to generate completions for, encoded as a list of dict with role and content","required":true,"items":{"type":"object","properties":{"role":{"type":"string","description":"Role of the message sender","required":true,"enum":["system","user","assistant","tool"]},"content":{"type":"string","description":"Content of the message. Can be a plain string or an array of content blocks for multimodal input","required":true}}}},"stream":{"type":"boolean","description":"Whether to stream the response"}}},"example":{"agent_id":"","messages":[{"role":"user","content":"What is the capital of France?"}],"stream":""}}}}}},"/v1/moderations":{"post":{"tags":["Moderation"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/moderations_v1_moderations_post","api_endpoint":"https://api.mistral.ai/v1/moderations"},"summary":"Moderations","description":"Moderate content","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"input":{"type":"string","description":"The input text to moderate","required":true}}},"example":{"input":""}}}}}},"/v1/chat/moderations":{"post":{"tags":["Moderation"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/chat_moderations_v1_chat_moderations_post","api_endpoint":"https://api.mistral.ai/v1/chat/moderations"},"summary":"Chat Moderations","description":"Moderate chat messages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"messages":{"type":"array","description":"The messages to moderate","required":true,"items":{"type":"object","properties":{"role":{"type":"string","description":"Role of the message sender","required":true,"enum":["system","user","assistant","tool"]},"content":{"type":"string","description":"Content of the message. Can be a plain string or an array of content blocks for multimodal input","required":true}}}}}},"example":{"messages":[{"role":"user","content":"What is the capital of France?"}]}}}}}},"/v1/classifications":{"post":{"tags":["Classification"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/classifications_v1_classifications_post","api_endpoint":"https://api.mistral.ai/v1/classifications"},"summary":"Classifications","description":"Classify content","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"input":{"type":"string","description":"The input text to classify","required":true},"labels":{"type":"array","description":"The labels to classify against","required":true,"items":{"type":"string"}}}},"example":{"input":"","labels":["positive","negative","neutral"]}}}}}},"/v1/chat/classifications":{"post":{"tags":["Classification"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/chat_classifications_v1_chat_classifications_post","api_endpoint":"https://api.mistral.ai/v1/chat/classifications"},"summary":"Chat Classifications","description":"Classify chat messages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labels":{"type":"array","description":"The labels to classify against","required":true,"items":{"type":"string"}},"messages":{"type":"array","description":"The messages to classify","required":true,"items":{"type":"object","properties":{"role":{"type":"string","description":"Role of the message sender","required":true,"enum":["system","user","assistant","tool"]},"content":{"type":"string","description":"Content of the message. Can be a plain string or an array of content blocks for multimodal input","required":true}}}}}},"example":{"labels":["positive","negative","neutral"],"messages":[{"role":"user","content":"What is the capital of France?"}]}}}}}},"/v1/ocr":{"post":{"tags":["OCR"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/ocr_v1_ocr_post","api_endpoint":"https://api.mistral.ai/v1/ocr"},"summary":"OCR","description":"Perform OCR on an image","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"image_url":{"type":"string","description":"The URL of the image to perform OCR on","required":true}}},"example":{"image_url":""}}}}}},"/v1/audio/transcriptions":{"post":{"tags":["Audio"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/audio_api_v1_transcriptions_post","api_endpoint":"https://api.mistral.ai/v1/audio/transcriptions"},"summary":"Create Transcription","description":"Create a transcription from an audio file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","format":"binary","description":"The audio file to transcribe","required":true},"model":{"type":"string","description":"The model to use for transcription"}}},"example":{"file":"(binary)","model":""}}}}}},"/v1/audio/transcriptions/stream":{"post":{"tags":["Audio"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/audio_api_v1_transcriptions_post_stream","api_endpoint":"https://api.mistral.ai/v1/audio/transcriptions"},"summary":"Create Streaming Transcription","description":"Create a streaming transcription from an audio file (SSE)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","format":"binary","description":"The audio file to transcribe","required":true},"model":{"type":"string","description":"The model to use for transcription"}}},"example":{"file":"(binary)","model":""}}}}}},"/v1/conversations":{"post":{"tags":["Conversations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_conversations_start","api_endpoint":"https://api.mistral.ai/v1/conversations"},"summary":"Create Conversation","description":"Create a new conversation, using a base model or an agent and append entries","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"agent_id":{"type":"string","description":"The agent ID to use for the conversation"},"messages":{"type":"array","description":"The messages for the conversation","required":true,"items":{"type":"object","properties":{"role":{"type":"string","description":"Role of the message sender","required":true,"enum":["user","assistant"]},"content":{"type":"string","description":"Content of the message","required":true}}}},"model":{"type":"string","description":"The model to use for the conversation"}}},"example":{"agent_id":"","messages":[{"role":"user","content":"Hello"}],"model":""}}}}},"get":{"tags":["Conversations"],"parameters":[{"name":"metadata","in":"query","description":"Metadata filter for conversations","schema":{"type":"object","example":""}},{"name":"page","in":"query","description":"Default: 0. The page number of the results to be returned","schema":{"type":"number","example":""}},{"name":"page_size","in":"query","description":"Default: 100. The number of items to return per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_conversations_list","api_endpoint":"https://api.mistral.ai/v1/conversations"},"summary":"List Conversations","description":"Retrieve a list of conversation entities sorted by creation time","security":[{"bearerAuth":[]}]}},"/v1/conversations/{conversation_id}":{"get":{"tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"The ID of the conversation to retrieve","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_conversations_get","api_endpoint":"https://api.mistral.ai/v1/conversations/{conversation_id}"},"summary":"Get Conversation","description":"Retrieve a conversation entity by its ID","security":[{"bearerAuth":[]}]},"post":{"tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"The ID of the conversation to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_conversations_update","api_endpoint":"https://api.mistral.ai/v1/conversations/{conversation_id}"},"summary":"Update Conversation","description":"Append entries to a conversation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"messages":{"type":"array","description":"The messages to append to the conversation","required":true,"items":{"type":"object","properties":{"role":{"type":"string","description":"Role of the message sender","required":true,"enum":["user","assistant"]},"content":{"type":"string","description":"Content of the message","required":true}}}}}},"example":{"messages":[{"role":"user","content":"Hello"}]}}}}},"delete":{"tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"The ID of the conversation to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_conversations_delete","api_endpoint":"https://api.mistral.ai/v1/conversations/{conversation_id}"},"summary":"Delete Conversation","description":"Delete a conversation entity","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/conversations/{conversation_id}/history":{"get":{"tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"The ID of the conversation","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_conversations_history","api_endpoint":"https://api.mistral.ai/v1/conversations/{conversation_id}/history"},"summary":"Get Conversation History","description":"Get the history of a conversation","security":[{"bearerAuth":[]}]}},"/v1/conversations/{conversation_id}/messages":{"get":{"tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"The ID of the conversation","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_conversations_messages","api_endpoint":"https://api.mistral.ai/v1/conversations/{conversation_id}/messages"},"summary":"Get Conversation Messages","description":"Get the messages of a conversation","security":[{"bearerAuth":[]}]}},"/v1/conversations/{conversation_id}/restart":{"post":{"tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"The ID of the conversation to restart","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/agents_api_v1_conversations_restart","api_endpoint":"https://api.mistral.ai/v1/conversations/{conversation_id}/restart"},"summary":"Restart Conversation","description":"Restart a conversation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/libraries":{"get":{"tags":["Libraries"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/libraries_list_v1","api_endpoint":"https://api.mistral.ai/v1/libraries"},"summary":"List Libraries","description":"List all libraries that you have created or have been shared with you","security":[{"bearerAuth":[]}]},"post":{"tags":["Libraries"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/libraries_create_v1","api_endpoint":"https://api.mistral.ai/v1/libraries"},"summary":"Create 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","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The description of the library"},"name":{"type":"string","description":"The name of the library","required":true}}},"example":{"description":"","name":""}}}}}},"/v1/libraries/{library_id}":{"get":{"tags":["Libraries"],"parameters":[{"name":"library_id","in":"path","description":"The ID of the library to retrieve","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/libraries_get_v1","api_endpoint":"https://api.mistral.ai/v1/libraries/{library_id}"},"summary":"Get Library","description":"Retrieve a library entity by its ID","security":[{"bearerAuth":[]}]},"put":{"tags":["Libraries"],"parameters":[{"name":"library_id","in":"path","description":"The ID of the library to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/libraries_update_v1","api_endpoint":"https://api.mistral.ai/v1/libraries/{library_id}"},"summary":"Update Library","description":"Update a library entity","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The description of the library"},"name":{"type":"string","description":"The name of the library"}}},"example":{"description":"","name":""}}}}},"delete":{"tags":["Libraries"],"parameters":[{"name":"library_id","in":"path","description":"The ID of the library to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/libraries_delete_v1","api_endpoint":"https://api.mistral.ai/v1/libraries/{library_id}"},"summary":"Delete Library","description":"Delete a library entity","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/libraries/{library_id}/documents":{"get":{"tags":["Libraries"],"parameters":[{"name":"library_id","in":"path","description":"The ID of the library","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/libraries_documents_list_v1","api_endpoint":"https://api.mistral.ai/v1/libraries/{library_id}/documents"},"summary":"List Library Documents","description":"List all documents in a library","security":[{"bearerAuth":[]}]},"post":{"tags":["Libraries"],"parameters":[{"name":"library_id","in":"path","description":"The ID of the library","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/libraries_documents_create_v1","api_endpoint":"https://api.mistral.ai/v1/libraries/{library_id}/documents"},"summary":"Create Library Document","description":"Create a new document in a library","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"document_url":{"type":"string","description":"The URL of the document to add","required":true}}},"example":{"document_url":""}}}}}},"/v1/libraries/{library_id}/documents/{document_id}":{"get":{"tags":["Libraries"],"parameters":[{"name":"document_id","in":"path","description":"The ID of the document","required":true,"schema":{"type":"string","example":""}},{"name":"library_id","in":"path","description":"The ID of the library","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/libraries_documents_get_v1","api_endpoint":"https://api.mistral.ai/v1/libraries/{library_id}/documents/{document_id}"},"summary":"Get Library Document","description":"Retrieve a document entity by its ID","security":[{"bearerAuth":[]}]},"delete":{"tags":["Libraries"],"parameters":[{"name":"document_id","in":"path","description":"The ID of the document to delete","required":true,"schema":{"type":"string","example":""}},{"name":"library_id","in":"path","description":"The ID of the library","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.mistral.ai/api/#operation/libraries_documents_delete_v1","api_endpoint":"https://api.mistral.ai/v1/libraries/{library_id}/documents/{document_id}"},"summary":"Delete Library Document","description":"Delete a document entity","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}