Rust API client for mistral-openapi-client
Our Chat Completion and Embeddings APIs specification. Create your account on La Plateforme to get access and read the docs to learn how to use it.
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version: 0.1.0
- Generator version: 7.20.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:
mistral-openapi-client = "0.1.0"
Documentation for API Endpoints
All URIs are relative to https://api.mistral.ai
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AgentsApi | agents_completion_v1_agents_completions_post | POST /v1/agents/completions | Agents Completion |
| AudioTranscriptionsApi | audio_api_v1_transcriptions_post | POST /v1/audio/transcriptions | Create Transcription |
| AudioTranscriptionsApi | audio_api_v1_transcriptions_post_stream | POST /v1/audio/transcriptions#stream | Create Streaming Transcription (SSE) |
| BatchApi | jobs_api_routes_batch_cancel_batch_job | POST /v1/batch/jobs/{job_id}/cancel | Cancel Batch Job |
| BatchApi | jobs_api_routes_batch_create_batch_job | POST /v1/batch/jobs | Create Batch Job |
| BatchApi | jobs_api_routes_batch_get_batch_job | GET /v1/batch/jobs/{job_id} | Get Batch Job |
| BatchApi | jobs_api_routes_batch_get_batch_jobs | GET /v1/batch/jobs | Get Batch Jobs |
| BetaAgentsApi | agents_api_v1_agents_create | POST /v1/agents | Create a agent that can be used within a conversation. |
| BetaAgentsApi | agents_api_v1_agents_create_or_update_alias | PUT /v1/agents/{agent_id}/aliases | Create or update an agent version alias. |
| BetaAgentsApi | agents_api_v1_agents_delete | DELETE /v1/agents/{agent_id} | Delete an agent entity. |
| BetaAgentsApi | agents_api_v1_agents_delete_alias | DELETE /v1/agents/{agent_id}/aliases | Delete an agent version alias. |
| BetaAgentsApi | agents_api_v1_agents_get | GET /v1/agents/{agent_id} | Retrieve an agent entity. |
| BetaAgentsApi | agents_api_v1_agents_get_version | GET /v1/agents/{agent_id}/versions/{version} | Retrieve a specific version of an agent. |
| BetaAgentsApi | agents_api_v1_agents_list | GET /v1/agents | List agent entities. |
| BetaAgentsApi | agents_api_v1_agents_list_version_aliases | GET /v1/agents/{agent_id}/aliases | List all aliases for an agent. |
| BetaAgentsApi | agents_api_v1_agents_list_versions | GET /v1/agents/{agent_id}/versions | List all versions of an agent. |
| BetaAgentsApi | agents_api_v1_agents_update | PATCH /v1/agents/{agent_id} | Update an agent entity. |
| BetaAgentsApi | agents_api_v1_agents_update_version | PATCH /v1/agents/{agent_id}/version | Update an agent version. |
| BetaConversationsApi | agents_api_v1_conversations_append | POST /v1/conversations/{conversation_id} | Append new entries to an existing conversation. |
| BetaConversationsApi | agents_api_v1_conversations_append_stream | POST /v1/conversations/{conversation_id}#stream | Append new entries to an existing conversation. |
| BetaConversationsApi | agents_api_v1_conversations_delete | DELETE /v1/conversations/{conversation_id} | Delete a conversation. |
| BetaConversationsApi | agents_api_v1_conversations_get | GET /v1/conversations/{conversation_id} | Retrieve a conversation information. |
| BetaConversationsApi | agents_api_v1_conversations_history | GET /v1/conversations/{conversation_id}/history | Retrieve all entries in a conversation. |
| BetaConversationsApi | agents_api_v1_conversations_list | GET /v1/conversations | List all created conversations. |
| BetaConversationsApi | agents_api_v1_conversations_messages | GET /v1/conversations/{conversation_id}/messages | Retrieve all messages in a conversation. |
| BetaConversationsApi | agents_api_v1_conversations_restart | POST /v1/conversations/{conversation_id}/restart | Restart a conversation starting from a given entry. |
| BetaConversationsApi | agents_api_v1_conversations_restart_stream | POST /v1/conversations/{conversation_id}/restart#stream | Restart a conversation starting from a given entry. |
| BetaConversationsApi | agents_api_v1_conversations_start | POST /v1/conversations | Create a conversation and append entries to it. |
| BetaConversationsApi | agents_api_v1_conversations_start_stream | POST /v1/conversations#stream | Create a conversation and append entries to it. |
| BetaLibrariesApi | libraries_create_v1 | POST /v1/libraries | Create a new Library. |
| BetaLibrariesApi | libraries_delete_v1 | DELETE /v1/libraries/{library_id} | Delete a library and all of it's document. |
| BetaLibrariesApi | libraries_get_v1 | GET /v1/libraries/{library_id} | Detailed information about a specific Library. |
| BetaLibrariesApi | libraries_list_v1 | GET /v1/libraries | List all libraries you have access to. |
| BetaLibrariesApi | libraries_update_v1 | PUT /v1/libraries/{library_id} | Update a library. |
| BetaLibrariesAccessesApi | libraries_share_create_v1 | PUT /v1/libraries/{library_id}/share | Create or update an access level. |
| BetaLibrariesAccessesApi | libraries_share_delete_v1 | DELETE /v1/libraries/{library_id}/share | Delete an access level. |
| BetaLibrariesAccessesApi | libraries_share_list_v1 | GET /v1/libraries/{library_id}/share | List all of the access to this library. |
| BetaLibrariesDocumentsApi | libraries_documents_delete_v1 | DELETE /v1/libraries/{library_id}/documents/{document_id} | Delete a document. |
| BetaLibrariesDocumentsApi | libraries_documents_get_extracted_text_signed_url_v1 | GET /v1/libraries/{library_id}/documents/{document_id}/extracted-text-signed-url | Retrieve the signed URL of text extracted from a given document. |
| BetaLibrariesDocumentsApi | libraries_documents_get_signed_url_v1 | GET /v1/libraries/{library_id}/documents/{document_id}/signed-url | Retrieve the signed URL of a specific document. |
| BetaLibrariesDocumentsApi | libraries_documents_get_status_v1 | GET /v1/libraries/{library_id}/documents/{document_id}/status | Retrieve the processing status of a specific document. |
| BetaLibrariesDocumentsApi | libraries_documents_get_text_content_v1 | GET /v1/libraries/{library_id}/documents/{document_id}/text_content | Retrieve the text content of a specific document. |
| BetaLibrariesDocumentsApi | libraries_documents_get_v1 | GET /v1/libraries/{library_id}/documents/{document_id} | Retrieve the metadata of a specific document. |
| BetaLibrariesDocumentsApi | libraries_documents_list_v1 | GET /v1/libraries/{library_id}/documents | List documents in a given library. |
| BetaLibrariesDocumentsApi | libraries_documents_reprocess_v1 | POST /v1/libraries/{library_id}/documents/{document_id}/reprocess | Reprocess a document. |
| BetaLibrariesDocumentsApi | libraries_documents_update_v1 | PUT /v1/libraries/{library_id}/documents/{document_id} | Update the metadata of a specific document. |
| BetaLibrariesDocumentsApi | libraries_documents_upload_v1 | POST /v1/libraries/{library_id}/documents | Upload a new document. |
| ChatApi | chat_completion_v1_chat_completions_post | POST /v1/chat/completions | Chat Completion |
| ClassifiersApi | chat_classifications_v1_chat_classifications_post | POST /v1/chat/classifications | Chat Classifications |
| ClassifiersApi | chat_moderations_v1_chat_moderations_post | POST /v1/chat/moderations | Chat Moderations |
| ClassifiersApi | classifications_v1_classifications_post | POST /v1/classifications | Classifications |
| ClassifiersApi | moderations_v1_moderations_post | POST /v1/moderations | Moderations |
| DeprecatedFineTuningApi | jobs_api_routes_fine_tuning_cancel_fine_tuning_job | POST /v1/fine_tuning/jobs/{job_id}/cancel | Cancel Fine Tuning Job |
| DeprecatedFineTuningApi | jobs_api_routes_fine_tuning_create_fine_tuning_job | POST /v1/fine_tuning/jobs | Create Fine Tuning Job |
| DeprecatedFineTuningApi | jobs_api_routes_fine_tuning_get_fine_tuning_job | GET /v1/fine_tuning/jobs/{job_id} | Get Fine Tuning Job |
| DeprecatedFineTuningApi | jobs_api_routes_fine_tuning_get_fine_tuning_jobs | GET /v1/fine_tuning/jobs | Get Fine Tuning Jobs |
| DeprecatedFineTuningApi | jobs_api_routes_fine_tuning_start_fine_tuning_job | POST /v1/fine_tuning/jobs/{job_id}/start | Start Fine Tuning Job |
| EmbeddingsApi | embeddings_v1_embeddings_post | POST /v1/embeddings | Embeddings |
| FilesApi | files_api_routes_delete_file | DELETE /v1/files/{file_id} | Delete File |
| FilesApi | files_api_routes_download_file | GET /v1/files/{file_id}/content | Download File |
| FilesApi | files_api_routes_get_signed_url | GET /v1/files/{file_id}/url | Get Signed Url |
| FilesApi | files_api_routes_list_files | GET /v1/files | List Files |
| FilesApi | files_api_routes_retrieve_file | GET /v1/files/{file_id} | Retrieve File |
| FilesApi | files_api_routes_upload_file | POST /v1/files | Upload File |
| FimApi | fim_completion_v1_fim_completions_post | POST /v1/fim/completions | Fim Completion |
| ModelsApi | delete_model_v1_models_model_id_delete | DELETE /v1/models/{model_id} | Delete Model |
| ModelsApi | jobs_api_routes_fine_tuning_archive_fine_tuned_model | POST /v1/fine_tuning/models/{model_id}/archive | Archive Fine Tuned Model |
| ModelsApi | jobs_api_routes_fine_tuning_unarchive_fine_tuned_model | DELETE /v1/fine_tuning/models/{model_id}/archive | Unarchive Fine Tuned Model |
| ModelsApi | jobs_api_routes_fine_tuning_update_fine_tuned_model | PATCH /v1/fine_tuning/models/{model_id} | Update Fine Tuned Model |
| ModelsApi | list_models_v1_models_get | GET /v1/models | List Models |
| ModelsApi | retrieve_model_v1_models_model_id_get | GET /v1/models/{model_id} | Retrieve Model |
| OcrApi | ocr_v1_ocr_post | POST /v1/ocr | OCR |
Documentation For Models
- Agent
- AgentAliasResponse
- AgentConversation
- AgentCreationRequest
- AgentHandoffDoneEvent
- AgentHandoffEntry
- AgentHandoffStartedEvent
- AgentUpdateRequest
- AgentVersion
- AgentVersion1
- AgentVersion2
- AgentsCompletionRequest
- Annotations
- Answer
- ApiEndpoint
- ApiKeyAuth
- ArchiveFtModelOut
- Arguments
- AssistantMessage
- AudioChunk
- AudioContent
- AudioEncoding
- AudioFormat
- AuthData
- BaseFieldDefinition
- BaseModelCard
- BaseTaskStatus
- BatchError
- BatchJobIn
- BatchJobOut
- BatchJobStatus
- BatchJobsOut
- BatchRequest
- BlobResourceContents
- BuiltInConnectors
- CampaignPreview
- CampaignPreviews
- CampaignSelectedEvents
- CampaignStatus
- ChatClassificationRequest
- ChatClassificationRequestInputs
- ChatCompletionChoice
- ChatCompletionEvent
- ChatCompletionEventIds
- ChatCompletionEventPreview
- ChatCompletionEvents
- ChatCompletionFieldOptions
- ChatCompletionFieldOptionsOptionsInner
- ChatCompletionFields
- ChatCompletionRequest
- ChatCompletionResponse
- ChatCompletionResponseBase
- ChatModerationRequest
- ChatTranscriptionEvent
- CheckpointOut
- ClassificationRequest
- ClassificationResponse
- ClassificationTargetResult
- ClassifierDetailedJobOut
- ClassifierFtModelOut
- ClassifierJobOut
- ClassifierTargetIn
- ClassifierTargetOut
- ClassifierTrainingParameters
- ClassifierTrainingParametersIn
- CodeInterpreterTool
- CompletionArgs
- CompletionArgsStop
- CompletionChunk
- CompletionDetailedJobOut
- CompletionEvent
- CompletionFtModelOut
- CompletionJobOut
- CompletionResponseStreamChoice
- CompletionTrainingParameters
- CompletionTrainingParametersIn
- Connector
- ConnectorMcpCreate
- ConnectorMcpUpdate
- ConnectorSupportedLanguage
- ConnectorsQueryFilters
- Content
- Content1
- Content2
- Content3
- Content4
- Content5Inner
- ContentChunk
- ConversationAppendRequest
- ConversationAppendRequestBase
- ConversationAppendStreamRequest
- ConversationEvents
- ConversationHistory
- ConversationInputs
- ConversationMessages
- ConversationPayload
- ConversationRequest
- ConversationRequestBase
- ConversationResponse
- ConversationRestartRequest
- ConversationRestartRequestBase
- ConversationRestartStreamRequest
- ConversationSource
- ConversationStreamRequest
- ConversationUsageInfo
- CustomConnector
- CustomConnectorAuthorization
- Data
- Data1
- DataInner
- Dataset
- DatasetExport
- DatasetImportTask
- DatasetImportTasks
- DatasetPreview
- DatasetPreviews
- DatasetRecord
- DatasetRecords
- DeleteDatasetRecordsInSchema
- DeleteFileOut
- DeleteModelOut
- DeltaMessage
- DeltaMessageContent
- Document
- DocumentLibraryTool
- DocumentOut
- DocumentTextContent
- DocumentUpdateIn
- DocumentUpdateInAttributesValue
- DocumentUrlChunk
- EmbeddedResource
- EmbeddingDtype
- EmbeddingRequest
- EmbeddingResponse
- EmbeddingResponseData
- EncodingFormat
- EntityType
- EntriesInner
- EventOut
- ExecutionConfig
- ExtraFieldsValue
- FeedResultChatCompletionEventPreview
- FieldGroup
- FieldOptionCountItem
- FieldOptionCounts
- FieldOptionCountsInSchema
- FileChunk
- FilePurpose
- FileSchema
- FileSignedUrl
- FileVisibility
- FilterCondition
- FilterGroup
- FilterGroupAndInner
- FilterPayload
- Filters
- FimCompletionRequest
- FimCompletionResponse
- FineTuneableModelType
- FtClassifierLossFunction
- FtModelCapabilitiesOut
- FtModelCard
- Function
- FunctionCall
- FunctionCallEntry
- FunctionCallEntryArguments
- FunctionCallEvent
- FunctionName
- FunctionResultEntry
- FunctionTool
- GetChatCompletionEventIdsInSchema
- GetChatCompletionEventsInSchema
- GithubRepositoryIn
- GithubRepositoryOut
- GuardrailConfig
- HttpValidationError
- Hyperparameters
- ImageContent
- ImageDetail
- ImageGenerationTool
- ImageUrl
- ImageUrlChunk
- Input
- Input1
- Input2
- InputAudio
- InstructRequest
- IntegrationsSchemasApiToolTool
- IntegrationsSchemasTurbineToolLocale
- JobIn
- JobMetadataOut
- JobsOut
- JsonSchema
- JudgeClassificationOutput
- JudgeClassificationOutputOption
- JudgeOutput
- JudgeOutputType
- JudgePreview
- JudgePreviews
- JudgeRegressionOutput
- LegacyJobMetadataOut
- LibraryIn
- LibraryInUpdate
- LibraryOut
- ListDocumentOut
- ListFilesOut
- ListLibraryOut
- ListSharingOut
- LocationInner
- McpResultMetadata
- McpServerIcon
- McpToolCallMetadata
- McpToolCallRequest
- McpToolCallResponse
- MessageEntriesInner
- MessageInputContentChunksInner
- MessageInputEntry
- MessageOutputContentChunksInner
- MessageOutputEntry
- MessageOutputEvent
- MessageResponse
- MessagesInner
- MetricOut
- MistralPromptMode
- ModelCapabilities
- ModelConversation
- ModelList
- ModerationLlmAction
- ModerationLlmv1CategoryThresholds
- ModerationLlmv1Config
- ModerationLlmv2CategoryThresholds
- ModerationLlmv2Config
- ModerationObject
- ModerationResponse
- Name
- OAuth2TokenAuth
- OcrImageObject
- OcrPageDimensions
- OcrPageObject
- OcrRequest
- OcrResponse
- OcrTableObject
- OcrUsageInfo
- Output
- OutputContentChunks
- OutputsInner
- PaginatedConnectors
- PaginatedResultCampaignPreview
- PaginatedResultChatCompletionEventPreview
- PaginatedResultDatasetImportTask
- PaginatedResultDatasetPreview
- PaginatedResultDatasetRecord
- PaginatedResultJudgePreview
- PaginationInfo
- PaginationResponse
- PatchDatasetInSchema
- PostCampaignInSchema
- PostChatCompletionEventJudgingInSchema
- PostDatasetImportFromCampaignInSchema
- PostDatasetImportFromDatasetInSchema
- PostDatasetImportFromExplorerInSchema
- PostDatasetImportFromFileInSchema
- PostDatasetImportFromPlaygroundInSchema
- PostDatasetInSchema
- PostDatasetRecordInSchema
- PostDatasetRecordJudgingInSchema
- PostJudgeInSchema
- Prediction
- ProcessStatus
- ProcessingStatusOut
- PutDatasetRecordPayloadInSchema
- PutDatasetRecordPropertiesInSchema
- PutJudgeInSchema
- RealtimeTranscriptionClientMessage
- RealtimeTranscriptionInputAudioAppend
- RealtimeTranscriptionInputAudioEnd
- RealtimeTranscriptionInputAudioFlush
- RealtimeTranscriptionSessionUpdateMessage
- RealtimeTranscriptionSessionUpdatePayload
- ReferenceChunk
- RequestSource
- Resource
- ResourceLink
- ResourceVisibility
- Response
- Response1
- Response2
- ResponseAnyOf
- ResponseBase
- ResponseDoneEvent
- ResponseErrorEvent
- ResponseFormat
- ResponseFormats
- ResponseRetrieveModelV1ModelsModelIdGet
- ResponseStartedEvent
- ResponseV1ConversationsGet
- ResponseV1ConversationsListInner
- RetrieveFileOut
- SampleType
- ShareEnum
- SharingDelete
- SharingIn
- SharingOut
- Source
- SseTypes
- Stop
- SystemMessage
- SystemMessageContentChunks
- TextChunk
- TextContent
- TextResourceContents
- ThinkChunk
- ThinkingInner
- TimestampGranularity
- Tool
- Tool1
- ToolCall
- ToolCallConfirmation
- ToolChoice
- ToolChoice1
- ToolChoiceEnum
- ToolConfiguration
- ToolExecutionDeltaEvent
- ToolExecutionDoneEvent
- ToolExecutionEntry
- ToolExecutionStartedEvent
- ToolFileChunk
- ToolMessage
- ToolReferenceChunk
- ToolTypes
- ToolsInner
- TrainingFile
- TranscriptionResponse
- TranscriptionSegmentChunk
- TranscriptionStreamDone
- TranscriptionStreamEventTypes
- TranscriptionStreamEvents
- TranscriptionStreamLanguage
- TranscriptionStreamSegmentDelta
- TranscriptionStreamTextDelta
- UnarchiveFtModelOut
- UpdateFtModelIn
- UploadFileOut
- UsageInfo
- UserMessage
- ValidationError
- WandbIntegration
- WandbIntegrationOut
- WebSearchPremiumTool
- WebSearchTool
To get access to the crate's generated documentation, use:
cargo doc --open