--- type: api title: Beta Connectors description: Welcome to Mistral AI's Api Reference --- import { CodeSample, CodeSampleTab, CodeSampleTabbedSection, ExpandableBreakout, ExpandableBreakoutDescription, ExpandableBreakoutProperties, ExpandableBreakoutTitle, ExpandableProperty, ExpandablePropertyBreakouts, ExpandablePropertyDefaultValue, ExpandablePropertyDescription, ExpandablePropertyTitle, ExpandableSection, FrontMatterDisplayType, Operation, OperationCodeSamplesSection, OperationDescriptionSection, OperationParametersSection, OperationRequestBodyDescriptionSection, OperationRequestBodyExamplesSection, OperationRequestBodySection, OperationResponseBodyDescriptionSection, OperationResponseBodyDisplayTypeSection, OperationResponseBodyExamplesSection, OperationResponseBodySection, OperationSummarySection, OperationTitleSection, Pill, ResponseExamplesTab, ResponseExamplesTabbedSection, ResponseTab, ResponseTabbedSection, Section, SectionContent, SectionTitle, Tag, TagDescription, TagTitle } from "@/app/[locale]/(api)/components/speakeasy"; # Beta Connectors Endpoints (beta) Connectors ## GET /v1/connectors \{#operation-connector_list_v1\} _List all connectors._ List all your custom connectors with keyset pagination and filters. Python ```python from mistralai.client import Mistral import os with Mistral( api_key=os.getenv("MISTRAL_API_KEY", ""), ) as mistral: res = mistral.beta.connectors.list(page_size=100) # Handle response print(res) ``` cURL ```curl curl https://api.mistral.ai/v1/connectors \ -X GET \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' ```
### Parameters \{#operation-connector_list_v1_parameters\} ConnectorsQueryFilters","children":[],"breakoutSubTypes":{}}} typeAnnotations={[{"title":"query","variant":"info"}]} hasExpandableContent={false} expandByDefault={false} > ##### query_filters \{#operation-connector_list_v1_parameters_query_filters\} ##### active \{#operation-connector_list_v1_parameters_query_filters_active\} Filter for active connectors for a given user, workspace and organization. ##### fetch_connection_secrets \{#operation-connector_list_v1_parameters_query_filters_fetch_connection_secrets\} Fetch connection secrets. _Default Value:_ `false` ##### cursor \{#operation-connector_list_v1_parameters_cursor\} ##### page_size \{#operation-connector_list_v1_parameters_page_size\}
### Responses Examples \{#operation-connector_list_v1_responses-examples\} 200 ```json { "items": [ { "created_at": "2025-10-07T20:56:01.974Z", "description": "ipsum eiusmod", "id": "consequat do", "modified_at": "2025-10-07T20:56:01.974Z", "name": "reprehenderit ut dolore" } ], "pagination": { "page_size": 87 } } ``` ### Responses \{#operation-connector_list_v1_responses\} 200 Successful Response Connector","children":[{"label":"Connector","linkedLabel":"Connector","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[{"title":"required","variant":"warning"}]} hasExpandableContent={true} expandByDefault={false} > ##### items \{#operation-connector_list_v1_responses_200_application-json_items\} #### Connector \{#operation-connector_list_v1_responses_200_application-json_items_connector\} ##### auth_type \{#operation-connector_list_v1_responses_200_application-json_items_connector_auth_type\} ##### created_at \{#operation-connector_list_v1_responses_200_application-json_items_connector_created_at\} ##### description \{#operation-connector_list_v1_responses_200_application-json_items_connector_description\} ##### id \{#operation-connector_list_v1_responses_200_application-json_items_connector_id\} ##### modified_at \{#operation-connector_list_v1_responses_200_application-json_items_connector_modified_at\} ##### name \{#operation-connector_list_v1_responses_200_application-json_items_connector_name\} ##### server \{#operation-connector_list_v1_responses_200_application-json_items_connector_server\} integrations__schemas__api__tool__Tool","children":[{"label":"integrations__schemas__api__tool__Tool","linkedLabel":"integrations__schemas__api__tool__Tool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### tools \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools\} #### integrations\_\_schemas\_\_api\_\_tool\_\_Tool \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool\} ##### active \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_active\} ##### created_at \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_created_at\} ##### description \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_description\} ExecutionConfig","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[{"title":"required","variant":"warning"}]} hasExpandableContent={true} expandByDefault={false} > ##### execution_config \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_execution_config\} Not typed since mcp config can changed / not stable we allow all extra fields and this is a dict TODO: once mcp is stable, we need to type this #### ExecutionConfig \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_execution_config_executionconfig\} Not typed since mcp config can changed / not stable we allow all extra fields and this is a dict TODO: once mcp is stable, we need to type this ##### AdditionalProperties \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_execution_config_executionconfig_additionalproperties\} ##### type \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_execution_config_executionconfig_type\} ##### id \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_id\} ##### jsonschema \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_jsonschema\} integrations__schemas__turbine__ToolLocale","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### locale \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_locale\} #### integrations\_\_schemas\_\_turbine\_\_ToolLocale \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale\} ##### description \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_description\} ##### name \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_name\} ##### usage_sentence \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_usage_sentence\} ##### modified_at \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_modified_at\} ##### name \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_name\} ##### system_prompt \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_system_prompt\} ##### visibility \{#operation-connector_list_v1_responses_200_application-json_items_connector_tools_integrations__schemas__api__tool__tool_visibility\} PaginationResponse","children":[],"breakoutSubTypes":{}}} typeAnnotations={[{"title":"required","variant":"warning"}]} hasExpandableContent={true} expandByDefault={false} > ##### pagination \{#operation-connector_list_v1_responses_200_application-json_pagination\} #### PaginationResponse \{#operation-connector_list_v1_responses_200_application-json_pagination_paginationresponse\} ##### next_cursor \{#operation-connector_list_v1_responses_200_application-json_pagination_paginationresponse_next_cursor\} ##### page_size \{#operation-connector_list_v1_responses_200_application-json_pagination_paginationresponse_page_size\} ## POST /v1/connectors \{#operation-connector_create_v1\} _Create a new connector._ Create a new MCP connector. You can customize its visibility, url and auth type. Python ```python from mistralai.client import Mistral import os with Mistral( api_key=os.getenv("MISTRAL_API_KEY", ""), ) as mistral: res = mistral.beta.connectors.create(name="", description="unibody usually despite slushy wherever reward stingy from", server="https://royal-majority.net/") # Handle response print(res) ``` cURL ```curl curl https://api.mistral.ai/v1/connectors \ -X POST \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' \ -H 'Content-Type: application/json' \ -d '{ "description": "ipsum eiusmod", "name": "consequat do", "server": "reprehenderit ut dolore" }' ```
### Request Example \{#operation-connector_create_v1_request-examples\} ```json { "description": "ipsum eiusmod", "name": "consequat do", "server": "reprehenderit ut dolore" } ```
### Request Body \{#operation-connector_create_v1_request\} AuthData","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### auth_data \{#operation-connector_create_v1_request_auth_data\} Optional additional authentication data for the connector. #### AuthData \{#operation-connector_create_v1_request_auth_data_authdata\} Optional additional authentication data for the connector. ##### client_id \{#operation-connector_create_v1_request_auth_data_authdata_client_id\} ##### client_secret \{#operation-connector_create_v1_request_auth_data_authdata_client_secret\} ##### description \{#operation-connector_create_v1_request_description\} The description of the connector. ##### headers \{#operation-connector_create_v1_request_headers\} Optional organization-level headers to be sent with the request to the mcp server. ##### icon_url \{#operation-connector_create_v1_request_icon_url\} The optional url of the icon you want to associate to the connector. ##### name \{#operation-connector_create_v1_request_name\} The name of the connector. Should be 64 char length maximum, alphanumeric, only underscores/dashes. ##### server \{#operation-connector_create_v1_request_server\} The url of the MCP server. ##### system_prompt \{#operation-connector_create_v1_request_system_prompt\} Optional system prompt for the connector. ##### visibility \{#operation-connector_create_v1_request_visibility\}
### Responses Examples \{#operation-connector_create_v1_responses-examples\} 201 ```json { "created_at": "2025-10-07T20:56:01.974Z", "description": "ipsum eiusmod", "id": "consequat do", "modified_at": "2025-10-07T20:56:01.974Z", "name": "reprehenderit ut dolore" } ``` ### Server-Side Events \{#operation-connector_create_v1_responses\} 201 Successful Response ##### auth_type \{#operation-connector_create_v1_responses_201_application-json_auth_type\} ##### created_at \{#operation-connector_create_v1_responses_201_application-json_created_at\} ##### description \{#operation-connector_create_v1_responses_201_application-json_description\} ##### id \{#operation-connector_create_v1_responses_201_application-json_id\} ##### modified_at \{#operation-connector_create_v1_responses_201_application-json_modified_at\} ##### name \{#operation-connector_create_v1_responses_201_application-json_name\} ##### server \{#operation-connector_create_v1_responses_201_application-json_server\} integrations__schemas__api__tool__Tool","children":[{"label":"integrations__schemas__api__tool__Tool","linkedLabel":"integrations__schemas__api__tool__Tool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### tools \{#operation-connector_create_v1_responses_201_application-json_tools\} #### integrations\_\_schemas\_\_api\_\_tool\_\_Tool \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool\} ##### active \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_active\} ##### created_at \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_created_at\} ##### description \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_description\} ExecutionConfig","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[{"title":"required","variant":"warning"}]} hasExpandableContent={true} expandByDefault={false} > ##### execution_config \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_execution_config\} Not typed since mcp config can changed / not stable we allow all extra fields and this is a dict TODO: once mcp is stable, we need to type this #### ExecutionConfig \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_execution_config_executionconfig\} Not typed since mcp config can changed / not stable we allow all extra fields and this is a dict TODO: once mcp is stable, we need to type this ##### AdditionalProperties \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_execution_config_executionconfig_additionalproperties\} ##### type \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_execution_config_executionconfig_type\} ##### id \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_id\} ##### jsonschema \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_jsonschema\} integrations__schemas__turbine__ToolLocale","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### locale \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_locale\} #### integrations\_\_schemas\_\_turbine\_\_ToolLocale \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale\} ##### description \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_description\} ##### name \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_name\} ##### usage_sentence \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_usage_sentence\} ##### modified_at \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_modified_at\} ##### name \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_name\} ##### system_prompt \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_system_prompt\} ##### visibility \{#operation-connector_create_v1_responses_201_application-json_tools_integrations__schemas__api__tool__tool_visibility\} ## GET /v1/connectors/\{connector\_id\_or\_name\}/auth\_url \{#operation-connector_get_auth_url_v1\} _Get the auth URL for a connector._ Get the OAuth2 authorization URL for a connector to initiate user authentication. cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/auth_url \ -X GET \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' ```
### Parameters \{#operation-connector_get_auth_url_v1_parameters\} ##### app_return_url \{#operation-connector_get_auth_url_v1_parameters_app_return_url\} ##### credentials_name \{#operation-connector_get_auth_url_v1_parameters_credentials_name\} ##### connector_id_or_name \{#operation-connector_get_auth_url_v1_parameters_connector_id_or_name\}
### Responses Examples \{#operation-connector_get_auth_url_v1_responses-examples\} 200 ```json { "auth_url": "ipsum eiusmod", "ttl": 87 } ``` ### Responses \{#operation-connector_get_auth_url_v1_responses\} 200 Successful Response ##### auth_url \{#operation-connector_get_auth_url_v1_responses_200_application-json_auth_url\} ##### ttl \{#operation-connector_get_auth_url_v1_responses_200_application-json_ttl\} ## POST /v1/connectors/\{connector\_id\_or\_name\}/tools/\{tool\_name\}/call \{#operation-connector_call_tool_v1\} _Call Connector Tool_ Call a tool on an MCP connector. Python ```python from mistralai.client import Mistral import os with Mistral( api_key=os.getenv("MISTRAL_API_KEY", ""), ) as mistral: res = mistral.beta.connectors.call_tool(tool_name="", connector_id_or_name="") # Handle response print(res) ``` cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/tools/{tool_name}/call \ -X POST \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' \ -H 'Content-Type: application/json' \ -d '{}' ```
### Parameters \{#operation-connector_call_tool_v1_parameters\} ##### tool_name \{#operation-connector_call_tool_v1_parameters_tool_name\} ##### credentials_name \{#operation-connector_call_tool_v1_parameters_credentials_name\} ##### connector_id_or_name \{#operation-connector_call_tool_v1_parameters_connector_id_or_name\}
### Request Example \{#operation-connector_call_tool_v1_request-examples\} ```json {} ```
### Request Body \{#operation-connector_call_tool_v1_request\} Request body for calling an MCP tool. ##### arguments \{#operation-connector_call_tool_v1_request_arguments\}
### Responses Examples \{#operation-connector_call_tool_v1_responses-examples\} 200 ```json { "content": [ { "text": "ipsum eiusmod", "type": "consequat do" } ] } ``` ### Responses \{#operation-connector_call_tool_v1_responses\} 200 Successful Response ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_additionalproperties\} TextContent","children":[],"breakoutSubTypes":{}},{"label":"ImageContent","linkedLabel":"ImageContent","children":[],"breakoutSubTypes":{}},{"label":"AudioContent","linkedLabel":"AudioContent","children":[],"breakoutSubTypes":{}},{"label":"ResourceLink","linkedLabel":"ResourceLink","children":[],"breakoutSubTypes":{}},{"label":"EmbeddedResource","linkedLabel":"EmbeddedResource","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[{"title":"required","variant":"warning"}]} hasExpandableContent={true} expandByDefault={false} > ##### content \{#operation-connector_call_tool_v1_responses_200_application-json_content\} #### TextContent \{#operation-connector_call_tool_v1_responses_200_application-json_content_textcontent\} Text content for a message. ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_content_textcontent_additionalproperties\} ##### _meta \{#operation-connector_call_tool_v1_responses_200_application-json_content_textcontent__meta\} Annotations","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### annotations \{#operation-connector_call_tool_v1_responses_200_application-json_content_textcontent_annotations\} #### Annotations \{#operation-connector_call_tool_v1_responses_200_application-json_content_textcontent_annotations_annotations\} ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_content_textcontent_annotations_annotations_additionalproperties\} ##### audience \{#operation-connector_call_tool_v1_responses_200_application-json_content_textcontent_annotations_annotations_audience\} ##### priority \{#operation-connector_call_tool_v1_responses_200_application-json_content_textcontent_annotations_annotations_priority\} ##### text \{#operation-connector_call_tool_v1_responses_200_application-json_content_textcontent_text\} ##### type \{#operation-connector_call_tool_v1_responses_200_application-json_content_textcontent_type\} #### ImageContent \{#operation-connector_call_tool_v1_responses_200_application-json_content_imagecontent\} Image content for a message. ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_content_imagecontent_additionalproperties\} ##### _meta \{#operation-connector_call_tool_v1_responses_200_application-json_content_imagecontent__meta\} Annotations","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### annotations \{#operation-connector_call_tool_v1_responses_200_application-json_content_imagecontent_annotations\} #### Annotations \{#operation-connector_call_tool_v1_responses_200_application-json_content_imagecontent_annotations_annotations\} ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_content_imagecontent_annotations_annotations_additionalproperties\} ##### audience \{#operation-connector_call_tool_v1_responses_200_application-json_content_imagecontent_annotations_annotations_audience\} ##### priority \{#operation-connector_call_tool_v1_responses_200_application-json_content_imagecontent_annotations_annotations_priority\} ##### data \{#operation-connector_call_tool_v1_responses_200_application-json_content_imagecontent_data\} ##### mimeType \{#operation-connector_call_tool_v1_responses_200_application-json_content_imagecontent_mimetype\} ##### type \{#operation-connector_call_tool_v1_responses_200_application-json_content_imagecontent_type\} #### AudioContent \{#operation-connector_call_tool_v1_responses_200_application-json_content_audiocontent\} Audio content for a message. ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_content_audiocontent_additionalproperties\} ##### _meta \{#operation-connector_call_tool_v1_responses_200_application-json_content_audiocontent__meta\} Annotations","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### annotations \{#operation-connector_call_tool_v1_responses_200_application-json_content_audiocontent_annotations\} #### Annotations \{#operation-connector_call_tool_v1_responses_200_application-json_content_audiocontent_annotations_annotations\} ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_content_audiocontent_annotations_annotations_additionalproperties\} ##### audience \{#operation-connector_call_tool_v1_responses_200_application-json_content_audiocontent_annotations_annotations_audience\} ##### priority \{#operation-connector_call_tool_v1_responses_200_application-json_content_audiocontent_annotations_annotations_priority\} ##### data \{#operation-connector_call_tool_v1_responses_200_application-json_content_audiocontent_data\} ##### mimeType \{#operation-connector_call_tool_v1_responses_200_application-json_content_audiocontent_mimetype\} ##### type \{#operation-connector_call_tool_v1_responses_200_application-json_content_audiocontent_type\} #### ResourceLink \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink\} A resource that the server is capable of reading, included in a prompt or tool call result. Note: resource links returned by tools are not guaranteed to appear in the results of `resources/list` requests. ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_additionalproperties\} ##### _meta \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink__meta\} Annotations","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### annotations \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_annotations\} #### Annotations \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_annotations_annotations\} ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_annotations_annotations_additionalproperties\} ##### audience \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_annotations_annotations_audience\} ##### priority \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_annotations_annotations_priority\} ##### description \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_description\} MCPServerIcon","children":[{"label":"MCPServerIcon","linkedLabel":"MCPServerIcon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### icons \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_icons\} #### MCPServerIcon \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_icons_mcpservericon\} An icon for display in user interfaces. ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_icons_mcpservericon_additionalproperties\} ##### mimeType \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_icons_mcpservericon_mimetype\} ##### sizes \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_icons_mcpservericon_sizes\} ##### src \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_icons_mcpservericon_src\} ##### mimeType \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_mimetype\} ##### name \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_name\} ##### size \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_size\} ##### title \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_title\} ##### type \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_type\} ##### uri \{#operation-connector_call_tool_v1_responses_200_application-json_content_resourcelink_uri\} #### EmbeddedResource \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource\} The contents of a resource, embedded into a prompt or tool call result. It is up to the client how best to render embedded resources for the benefit of the LLM and/or the user. ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_additionalproperties\} ##### _meta \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource__meta\} Annotations","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### annotations \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_annotations\} #### Annotations \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_annotations_annotations\} ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_annotations_annotations_additionalproperties\} ##### audience \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_annotations_annotations_audience\} ##### priority \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_annotations_annotations_priority\} TextResourceContents","children":[],"breakoutSubTypes":{}},{"label":"BlobResourceContents","linkedLabel":"BlobResourceContents","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[{"title":"required","variant":"warning"}]} hasExpandableContent={true} expandByDefault={false} > ##### resource \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_resource\} #### TextResourceContents \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_resource_textresourcecontents\} Text contents of a resource. ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_resource_textresourcecontents_additionalproperties\} ##### _meta \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_resource_textresourcecontents__meta\} ##### mimeType \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_resource_textresourcecontents_mimetype\} ##### text \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_resource_textresourcecontents_text\} ##### uri \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_resource_textresourcecontents_uri\} #### BlobResourceContents \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_resource_blobresourcecontents\} Binary contents of a resource. ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_resource_blobresourcecontents_additionalproperties\} ##### _meta \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_resource_blobresourcecontents__meta\} ##### blob \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_resource_blobresourcecontents_blob\} ##### mimeType \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_resource_blobresourcecontents_mimetype\} ##### uri \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_resource_blobresourcecontents_uri\} ##### type \{#operation-connector_call_tool_v1_responses_200_application-json_content_embeddedresource_type\} MCPToolCallMetadata","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### metadata \{#operation-connector_call_tool_v1_responses_200_application-json_metadata\} Metadata wrapper for MCP tool call responses. Nests MCP-specific fields under `mcp_meta` to avoid collisions with other metadata keys (e.g. `tool_call_result`) in Harmattan's streaming deltas. #### MCPToolCallMetadata \{#operation-connector_call_tool_v1_responses_200_application-json_metadata_mcptoolcallmetadata\} Metadata wrapper for MCP tool call responses. Nests MCP-specific fields under `mcp_meta` to avoid collisions with other metadata keys (e.g. `tool_call_result`) in Harmattan's streaming deltas. ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_metadata_mcptoolcallmetadata_additionalproperties\} MCPResultMetadata","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### mcp_meta \{#operation-connector_call_tool_v1_responses_200_application-json_metadata_mcptoolcallmetadata_mcp_meta\} MCP-specific result metadata (isError, structuredContent, _meta). #### MCPResultMetadata \{#operation-connector_call_tool_v1_responses_200_application-json_metadata_mcptoolcallmetadata_mcp_meta_mcpresultmetadata\} MCP-specific result metadata (isError, structuredContent, _meta). ##### AdditionalProperties \{#operation-connector_call_tool_v1_responses_200_application-json_metadata_mcptoolcallmetadata_mcp_meta_mcpresultmetadata_additionalproperties\} ##### _meta \{#operation-connector_call_tool_v1_responses_200_application-json_metadata_mcptoolcallmetadata_mcp_meta_mcpresultmetadata__meta\} ##### isError \{#operation-connector_call_tool_v1_responses_200_application-json_metadata_mcptoolcallmetadata_mcp_meta_mcpresultmetadata_iserror\} _Default Value:_ `false` ##### structuredContent \{#operation-connector_call_tool_v1_responses_200_application-json_metadata_mcptoolcallmetadata_mcp_meta_mcpresultmetadata_structuredcontent\} ## GET /v1/connectors/\{connector\_id\_or\_name\}/tools \{#operation-connector_list_tools_v1\} _List tools for a connector._ List all tools available for an MCP connector. cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/tools \ -X GET \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' ``` ### Responses Examples \{#operation-connector_list_tools_v1_responses-examples\} 200 ```json null ``` ### Responses \{#operation-connector_list_tools_v1_responses\} 200 integrations__schemas__api__tool__Tool","children":[{"label":"integrations__schemas__api__tool__Tool","linkedLabel":"integrations__schemas__api__tool__Tool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"array","linkedLabel":"MCPTool","children":[{"label":"MCPTool","linkedLabel":"MCPTool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"array","linkedLabel":"any","children":[{"label":"map","linkedLabel":"any","children":[{"label":"any","linkedLabel":"any","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} /> Successful Response #### integrations\_\_schemas\_\_api\_\_tool\_\_Tool \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool\} ##### active \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_active\} ##### created_at \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_created_at\} ##### description \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_description\} ExecutionConfig","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[{"title":"required","variant":"warning"}]} hasExpandableContent={true} expandByDefault={false} > ##### execution_config \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_execution_config\} Not typed since mcp config can changed / not stable we allow all extra fields and this is a dict TODO: once mcp is stable, we need to type this #### ExecutionConfig \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_execution_config_executionconfig\} Not typed since mcp config can changed / not stable we allow all extra fields and this is a dict TODO: once mcp is stable, we need to type this ##### AdditionalProperties \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_execution_config_executionconfig_additionalproperties\} ##### type \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_execution_config_executionconfig_type\} ##### id \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_id\} ##### jsonschema \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_jsonschema\} integrations__schemas__turbine__ToolLocale","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### locale \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_locale\} #### integrations\_\_schemas\_\_turbine\_\_ToolLocale \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale\} ##### description \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_description\} ##### name \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_name\} ##### usage_sentence \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_usage_sentence\} ##### modified_at \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_modified_at\} ##### name \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_name\} ##### system_prompt \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_system_prompt\} ##### visibility \{#operation-connector_list_tools_v1_responses_200_application-json_integrations__schemas__api__tool__tool_visibility\} #### MCPTool \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool\} ##### AdditionalProperties \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_additionalproperties\} MCPToolMeta","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### _meta \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta\} Typed _meta for MCP tools. Only the 'ui' field is typed. Other fields are allowed via extra="allow". #### MCPToolMeta \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta\} Typed _meta for MCP tools. Only the 'ui' field is typed. Other fields are allowed via extra="allow". ##### AdditionalProperties \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_additionalproperties\} TurbineToolMeta","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### ai.mistral/turbine \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ai.mistral/turbine\} #### TurbineToolMeta \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ai.mistral/turbine_turbinetoolmeta\} TurbineToolLocale","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### locale \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ai.mistral/turbine_turbinetoolmeta_locale\} #### TurbineToolLocale \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ai.mistral/turbine_turbinetoolmeta_locale_turbinetoollocale\} ##### description \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ai.mistral/turbine_turbinetoolmeta_locale_turbinetoollocale_description\} ##### done_description \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ai.mistral/turbine_turbinetoolmeta_locale_turbinetoollocale_done_description\} ##### name \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ai.mistral/turbine_turbinetoolmeta_locale_turbinetoollocale_name\} ##### usage_sentence \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ai.mistral/turbine_turbinetoolmeta_locale_turbinetoollocale_usage_sentence\} ##### working_description \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ai.mistral/turbine_turbinetoolmeta_locale_turbinetoollocale_working_description\} ##### private_execution \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ai.mistral/turbine_turbinetoolmeta_private_execution\} ##### timeout \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ai.mistral/turbine_turbinetoolmeta_timeout\} ##### tool_type \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ai.mistral/turbine_turbinetoolmeta_tool_type\} MCPUIToolMeta","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### ui \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ui\} UI metadata for tools that reference UI resources. #### MCPUIToolMeta \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ui_mcpuitoolmeta\} UI metadata for tools that reference UI resources. ##### AdditionalProperties \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ui_mcpuitoolmeta_additionalproperties\} ##### resourceUri \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ui_mcpuitoolmeta_resourceuri\} ##### visibility \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool__meta_mcptoolmeta_ui_mcpuitoolmeta_visibility\} ToolAnnotations","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### annotations \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_annotations\} Additional properties describing a Tool to clients. NOTE: all properties in ToolAnnotations are **hints**. They are not guaranteed to provide a faithful description of tool behavior (including descriptive properties like `title`). Clients should never make tool use decisions based on ToolAnnotations received from untrusted servers. #### ToolAnnotations \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_annotations_toolannotations\} Additional properties describing a Tool to clients. NOTE: all properties in ToolAnnotations are **hints**. They are not guaranteed to provide a faithful description of tool behavior (including descriptive properties like `title`). Clients should never make tool use decisions based on ToolAnnotations received from untrusted servers. ##### AdditionalProperties \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_annotations_toolannotations_additionalproperties\} ##### destructiveHint \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_annotations_toolannotations_destructivehint\} ##### idempotentHint \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_annotations_toolannotations_idempotenthint\} ##### openWorldHint \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_annotations_toolannotations_openworldhint\} ##### readOnlyHint \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_annotations_toolannotations_readonlyhint\} ##### title \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_annotations_toolannotations_title\} ##### description \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_description\} ToolExecution","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### execution \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_execution\} Execution-related properties for a tool. #### ToolExecution \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_execution_toolexecution\} Execution-related properties for a tool. ##### AdditionalProperties \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_execution_toolexecution_additionalproperties\} ##### taskSupport \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_execution_toolexecution_tasksupport\} MCPServerIcon","children":[{"label":"MCPServerIcon","linkedLabel":"MCPServerIcon","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### icons \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_icons\} #### MCPServerIcon \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_icons_mcpservericon\} An icon for display in user interfaces. ##### AdditionalProperties \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_icons_mcpservericon_additionalproperties\} ##### mimeType \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_icons_mcpservericon_mimetype\} ##### sizes \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_icons_mcpservericon_sizes\} ##### src \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_icons_mcpservericon_src\} ##### inputSchema \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_inputschema\} ##### name \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_name\} ##### outputSchema \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_outputschema\} ##### title \{#operation-connector_list_tools_v1_responses_200_application-json_mcptool_title\} ## GET /v1/connectors/\{connector\_id\_or\_name\}/authentication\_methods \{#operation-connector_get_authentication_methods_v1\} _Get authentication methods for a connector._ Get the authentication schema for a connector. Returns the list of supported authentication methods and their required headers. cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/authentication_methods \ -X GET \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' ```
### Parameters \{#operation-connector_get_authentication_methods_v1_parameters\} ##### connector_id_or_name \{#operation-connector_get_authentication_methods_v1_parameters_connector_id_or_name\}
### Responses Examples \{#operation-connector_get_authentication_methods_v1_responses-examples\} 200 ```json [ { "method_type": "oauth2" } ] ``` ### Responses \{#operation-connector_get_authentication_methods_v1_responses\} 200 PublicAuthenticationMethod","children":[{"label":"PublicAuthenticationMethod","linkedLabel":"PublicAuthenticationMethod","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} /> Successful Response #### PublicAuthenticationMethod \{#operation-connector_get_authentication_methods_v1_responses_200_application-json_publicauthenticationmethod\} Public view of an authentication method, without secrets. ConnectorAuthenticationHeader","children":[{"label":"ConnectorAuthenticationHeader","linkedLabel":"ConnectorAuthenticationHeader","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### headers \{#operation-connector_get_authentication_methods_v1_responses_200_application-json_publicauthenticationmethod_headers\} #### ConnectorAuthenticationHeader \{#operation-connector_get_authentication_methods_v1_responses_200_application-json_publicauthenticationmethod_headers_connectorauthenticationheader\} ##### is_required \{#operation-connector_get_authentication_methods_v1_responses_200_application-json_publicauthenticationmethod_headers_connectorauthenticationheader_is_required\} _Default Value:_ `true` ##### is_secret \{#operation-connector_get_authentication_methods_v1_responses_200_application-json_publicauthenticationmethod_headers_connectorauthenticationheader_is_secret\} _Default Value:_ `true` ##### name \{#operation-connector_get_authentication_methods_v1_responses_200_application-json_publicauthenticationmethod_headers_connectorauthenticationheader_name\} ##### method_type \{#operation-connector_get_authentication_methods_v1_responses_200_application-json_publicauthenticationmethod_method_type\} ## GET /v1/connectors/\{connector\_id\_or\_name\}/organization/credentials \{#operation-connector_list_organization_credentials_v1\} _List organization credentials for a connector._ List all credentials configured at the organization level for a given connector. cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/organization/credentials \ -X GET \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' ```
### Parameters \{#operation-connector_list_organization_credentials_v1_parameters\} ##### auth_type \{#operation-connector_list_organization_credentials_v1_parameters_auth_type\} ##### fetch_default \{#operation-connector_list_organization_credentials_v1_parameters_fetch_default\} ##### connector_id_or_name \{#operation-connector_list_organization_credentials_v1_parameters_connector_id_or_name\}
### Responses Examples \{#operation-connector_list_organization_credentials_v1_responses-examples\} 200 ```json { "credentials": [ { "authentication_type": "oauth2", "name": "ipsum eiusmod" } ] } ``` ### Responses \{#operation-connector_list_organization_credentials_v1_responses\} 200 Successful Response ##### connector_preset_credentials_for_auth \{#operation-connector_list_organization_credentials_v1_responses_200_application-json_connector_preset_credentials_for_auth\} AuthenticationConfiguration","children":[{"label":"AuthenticationConfiguration","linkedLabel":"AuthenticationConfiguration","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[{"title":"required","variant":"warning"}]} hasExpandableContent={true} expandByDefault={false} > ##### credentials \{#operation-connector_list_organization_credentials_v1_responses_200_application-json_credentials\} #### AuthenticationConfiguration \{#operation-connector_list_organization_credentials_v1_responses_200_application-json_credentials_authenticationconfiguration\} ##### authentication_type \{#operation-connector_list_organization_credentials_v1_responses_200_application-json_credentials_authenticationconfiguration_authentication_type\} ##### is_default \{#operation-connector_list_organization_credentials_v1_responses_200_application-json_credentials_authenticationconfiguration_is_default\} _Default Value:_ `false` ##### name \{#operation-connector_list_organization_credentials_v1_responses_200_application-json_credentials_authenticationconfiguration_name\} ## POST /v1/connectors/\{connector\_id\_or\_name\}/organization/credentials \{#operation-connector_create_or_update_organization_credentials_v1\} _Create or update organization credentials for a connector._ Create or update credentials at the organization level for a given connector. cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/organization/credentials \ -X POST \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' \ -H 'Content-Type: application/json' \ -d '{ "name": "ipsum eiusmod" }' ```
### Parameters \{#operation-connector_create_or_update_organization_credentials_v1_parameters\} ##### connector_id_or_name \{#operation-connector_create_or_update_organization_credentials_v1_parameters_connector_id_or_name\}
### Request Example \{#operation-connector_create_or_update_organization_credentials_v1_request-examples\} ```json { "name": "ipsum eiusmod" } ```
### Request Body \{#operation-connector_create_or_update_organization_credentials_v1_request\} Request to create or update non-OAuth2 credentials for a connector. ConnectionCredentials","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### credentials \{#operation-connector_create_or_update_organization_credentials_v1_request_credentials\} The credential data (headers, bearer_token). #### ConnectionCredentials \{#operation-connector_create_or_update_organization_credentials_v1_request_credentials_connectioncredentials\} The credential data (headers, bearer_token). ##### bearer_token \{#operation-connector_create_or_update_organization_credentials_v1_request_credentials_connectioncredentials_bearer_token\} ##### headers \{#operation-connector_create_or_update_organization_credentials_v1_request_credentials_connectioncredentials_headers\} OAuth2Token","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### oauth \{#operation-connector_create_or_update_organization_credentials_v1_request_credentials_connectioncredentials_oauth\} #### OAuth2Token \{#operation-connector_create_or_update_organization_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token\} ##### access_token \{#operation-connector_create_or_update_organization_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_access_token\} ##### expires_at \{#operation-connector_create_or_update_organization_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_expires_at\} ##### expires_in \{#operation-connector_create_or_update_organization_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_expires_in\} ##### refresh_token \{#operation-connector_create_or_update_organization_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_refresh_token\} ##### scope \{#operation-connector_create_or_update_organization_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_scope\} ##### token_type \{#operation-connector_create_or_update_organization_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_token_type\} _Default Value:_ `"Bearer"` ##### is_default \{#operation-connector_create_or_update_organization_credentials_v1_request_is_default\} Controls whether this credential is the default for its auth method. On creation: if no credential exists yet for this auth method, the credential is automatically set as default when is_default is true or omitted; setting is_default to false is rejected because a default must exist. If other credentials already exist, setting is_default to true promotes this credential (demoting the previous default); false or omitted creates it as non-default. On update: true promotes this credential, false is rejected if it is currently the default (promote another credential first), omitted leaves the default status unchanged. ##### name \{#operation-connector_create_or_update_organization_credentials_v1_request_name\} Name of the credentials. Use this name to access or modify your credentials.
### Responses Examples \{#operation-connector_create_or_update_organization_credentials_v1_responses-examples\} 200 ```json { "message": "ipsum eiusmod" } ``` ### Responses \{#operation-connector_create_or_update_organization_credentials_v1_responses\} 200 Successful Response ##### message \{#operation-connector_create_or_update_organization_credentials_v1_responses_200_application-json_message\} ## GET /v1/connectors/\{connector\_id\_or\_name\}/workspace/credentials \{#operation-connector_list_workspace_credentials_v1\} _List workspace credentials for a connector._ List all credentials configured at the workspace level for a given connector. cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/workspace/credentials \ -X GET \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' ```
### Parameters \{#operation-connector_list_workspace_credentials_v1_parameters\} ##### auth_type \{#operation-connector_list_workspace_credentials_v1_parameters_auth_type\} ##### fetch_default \{#operation-connector_list_workspace_credentials_v1_parameters_fetch_default\} ##### connector_id_or_name \{#operation-connector_list_workspace_credentials_v1_parameters_connector_id_or_name\}
### Responses Examples \{#operation-connector_list_workspace_credentials_v1_responses-examples\} 200 ```json { "credentials": [ { "authentication_type": "oauth2", "name": "ipsum eiusmod" } ] } ``` ### Responses \{#operation-connector_list_workspace_credentials_v1_responses\} 200 Successful Response ##### connector_preset_credentials_for_auth \{#operation-connector_list_workspace_credentials_v1_responses_200_application-json_connector_preset_credentials_for_auth\} AuthenticationConfiguration","children":[{"label":"AuthenticationConfiguration","linkedLabel":"AuthenticationConfiguration","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[{"title":"required","variant":"warning"}]} hasExpandableContent={true} expandByDefault={false} > ##### credentials \{#operation-connector_list_workspace_credentials_v1_responses_200_application-json_credentials\} #### AuthenticationConfiguration \{#operation-connector_list_workspace_credentials_v1_responses_200_application-json_credentials_authenticationconfiguration\} ##### authentication_type \{#operation-connector_list_workspace_credentials_v1_responses_200_application-json_credentials_authenticationconfiguration_authentication_type\} ##### is_default \{#operation-connector_list_workspace_credentials_v1_responses_200_application-json_credentials_authenticationconfiguration_is_default\} _Default Value:_ `false` ##### name \{#operation-connector_list_workspace_credentials_v1_responses_200_application-json_credentials_authenticationconfiguration_name\} ## POST /v1/connectors/\{connector\_id\_or\_name\}/workspace/credentials \{#operation-connector_create_or_update_workspace_credentials_v1\} _Create or update workspace credentials for a connector._ Create or update credentials at the workspace level for a given connector. cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/workspace/credentials \ -X POST \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' \ -H 'Content-Type: application/json' \ -d '{ "name": "ipsum eiusmod" }' ```
### Parameters \{#operation-connector_create_or_update_workspace_credentials_v1_parameters\} ##### connector_id_or_name \{#operation-connector_create_or_update_workspace_credentials_v1_parameters_connector_id_or_name\}
### Request Example \{#operation-connector_create_or_update_workspace_credentials_v1_request-examples\} ```json { "name": "ipsum eiusmod" } ```
### Request Body \{#operation-connector_create_or_update_workspace_credentials_v1_request\} Request to create or update non-OAuth2 credentials for a connector. ConnectionCredentials","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### credentials \{#operation-connector_create_or_update_workspace_credentials_v1_request_credentials\} The credential data (headers, bearer_token). #### ConnectionCredentials \{#operation-connector_create_or_update_workspace_credentials_v1_request_credentials_connectioncredentials\} The credential data (headers, bearer_token). ##### bearer_token \{#operation-connector_create_or_update_workspace_credentials_v1_request_credentials_connectioncredentials_bearer_token\} ##### headers \{#operation-connector_create_or_update_workspace_credentials_v1_request_credentials_connectioncredentials_headers\} OAuth2Token","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### oauth \{#operation-connector_create_or_update_workspace_credentials_v1_request_credentials_connectioncredentials_oauth\} #### OAuth2Token \{#operation-connector_create_or_update_workspace_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token\} ##### access_token \{#operation-connector_create_or_update_workspace_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_access_token\} ##### expires_at \{#operation-connector_create_or_update_workspace_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_expires_at\} ##### expires_in \{#operation-connector_create_or_update_workspace_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_expires_in\} ##### refresh_token \{#operation-connector_create_or_update_workspace_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_refresh_token\} ##### scope \{#operation-connector_create_or_update_workspace_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_scope\} ##### token_type \{#operation-connector_create_or_update_workspace_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_token_type\} _Default Value:_ `"Bearer"` ##### is_default \{#operation-connector_create_or_update_workspace_credentials_v1_request_is_default\} Controls whether this credential is the default for its auth method. On creation: if no credential exists yet for this auth method, the credential is automatically set as default when is_default is true or omitted; setting is_default to false is rejected because a default must exist. If other credentials already exist, setting is_default to true promotes this credential (demoting the previous default); false or omitted creates it as non-default. On update: true promotes this credential, false is rejected if it is currently the default (promote another credential first), omitted leaves the default status unchanged. ##### name \{#operation-connector_create_or_update_workspace_credentials_v1_request_name\} Name of the credentials. Use this name to access or modify your credentials.
### Responses Examples \{#operation-connector_create_or_update_workspace_credentials_v1_responses-examples\} 200 ```json { "message": "ipsum eiusmod" } ``` ### Responses \{#operation-connector_create_or_update_workspace_credentials_v1_responses\} 200 Successful Response ##### message \{#operation-connector_create_or_update_workspace_credentials_v1_responses_200_application-json_message\} ## GET /v1/connectors/\{connector\_id\_or\_name\}/user/credentials \{#operation-connector_list_user_credentials_v1\} _List user credentials for a connector._ List all credentials configured at the user level for a given connector. cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/user/credentials \ -X GET \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' ```
### Parameters \{#operation-connector_list_user_credentials_v1_parameters\} ##### auth_type \{#operation-connector_list_user_credentials_v1_parameters_auth_type\} ##### fetch_default \{#operation-connector_list_user_credentials_v1_parameters_fetch_default\} ##### connector_id_or_name \{#operation-connector_list_user_credentials_v1_parameters_connector_id_or_name\}
### Responses Examples \{#operation-connector_list_user_credentials_v1_responses-examples\} 200 ```json { "credentials": [ { "authentication_type": "oauth2", "name": "ipsum eiusmod" } ] } ``` ### Responses \{#operation-connector_list_user_credentials_v1_responses\} 200 Successful Response ##### connector_preset_credentials_for_auth \{#operation-connector_list_user_credentials_v1_responses_200_application-json_connector_preset_credentials_for_auth\} AuthenticationConfiguration","children":[{"label":"AuthenticationConfiguration","linkedLabel":"AuthenticationConfiguration","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[{"title":"required","variant":"warning"}]} hasExpandableContent={true} expandByDefault={false} > ##### credentials \{#operation-connector_list_user_credentials_v1_responses_200_application-json_credentials\} #### AuthenticationConfiguration \{#operation-connector_list_user_credentials_v1_responses_200_application-json_credentials_authenticationconfiguration\} ##### authentication_type \{#operation-connector_list_user_credentials_v1_responses_200_application-json_credentials_authenticationconfiguration_authentication_type\} ##### is_default \{#operation-connector_list_user_credentials_v1_responses_200_application-json_credentials_authenticationconfiguration_is_default\} _Default Value:_ `false` ##### name \{#operation-connector_list_user_credentials_v1_responses_200_application-json_credentials_authenticationconfiguration_name\} ## POST /v1/connectors/\{connector\_id\_or\_name\}/user/credentials \{#operation-connector_create_or_update_user_credentials_v1\} _Create or update user credentials for a connector._ Create or update credentials at the user level for a given connector. cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/user/credentials \ -X POST \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' \ -H 'Content-Type: application/json' \ -d '{ "name": "ipsum eiusmod" }' ```
### Parameters \{#operation-connector_create_or_update_user_credentials_v1_parameters\} ##### connector_id_or_name \{#operation-connector_create_or_update_user_credentials_v1_parameters_connector_id_or_name\}
### Request Example \{#operation-connector_create_or_update_user_credentials_v1_request-examples\} ```json { "name": "ipsum eiusmod" } ```
### Request Body \{#operation-connector_create_or_update_user_credentials_v1_request\} Request to create or update non-OAuth2 credentials for a connector. ConnectionCredentials","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### credentials \{#operation-connector_create_or_update_user_credentials_v1_request_credentials\} The credential data (headers, bearer_token). #### ConnectionCredentials \{#operation-connector_create_or_update_user_credentials_v1_request_credentials_connectioncredentials\} The credential data (headers, bearer_token). ##### bearer_token \{#operation-connector_create_or_update_user_credentials_v1_request_credentials_connectioncredentials_bearer_token\} ##### headers \{#operation-connector_create_or_update_user_credentials_v1_request_credentials_connectioncredentials_headers\} OAuth2Token","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### oauth \{#operation-connector_create_or_update_user_credentials_v1_request_credentials_connectioncredentials_oauth\} #### OAuth2Token \{#operation-connector_create_or_update_user_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token\} ##### access_token \{#operation-connector_create_or_update_user_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_access_token\} ##### expires_at \{#operation-connector_create_or_update_user_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_expires_at\} ##### expires_in \{#operation-connector_create_or_update_user_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_expires_in\} ##### refresh_token \{#operation-connector_create_or_update_user_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_refresh_token\} ##### scope \{#operation-connector_create_or_update_user_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_scope\} ##### token_type \{#operation-connector_create_or_update_user_credentials_v1_request_credentials_connectioncredentials_oauth_oauth2token_token_type\} _Default Value:_ `"Bearer"` ##### is_default \{#operation-connector_create_or_update_user_credentials_v1_request_is_default\} Controls whether this credential is the default for its auth method. On creation: if no credential exists yet for this auth method, the credential is automatically set as default when is_default is true or omitted; setting is_default to false is rejected because a default must exist. If other credentials already exist, setting is_default to true promotes this credential (demoting the previous default); false or omitted creates it as non-default. On update: true promotes this credential, false is rejected if it is currently the default (promote another credential first), omitted leaves the default status unchanged. ##### name \{#operation-connector_create_or_update_user_credentials_v1_request_name\} Name of the credentials. Use this name to access or modify your credentials.
### Responses Examples \{#operation-connector_create_or_update_user_credentials_v1_responses-examples\} 200 ```json { "message": "ipsum eiusmod" } ``` ### Responses \{#operation-connector_create_or_update_user_credentials_v1_responses\} 200 Successful Response ##### message \{#operation-connector_create_or_update_user_credentials_v1_responses_200_application-json_message\} ## DELETE /v1/connectors/\{connector\_id\_or\_name\}/organization/credentials/\{credentials\_name\} \{#operation-connector_delete_organization_credentials_v1\} _Delete organization credentials for a connector._ Delete credentials at the organization level for a given connector. cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/organization/credentials/{credentials_name} \ -X DELETE \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' \ -H 'Content-Type: application/json' ```
### Parameters \{#operation-connector_delete_organization_credentials_v1_parameters\} ##### credentials_name \{#operation-connector_delete_organization_credentials_v1_parameters_credentials_name\} ##### connector_id_or_name \{#operation-connector_delete_organization_credentials_v1_parameters_connector_id_or_name\}
### Responses Examples \{#operation-connector_delete_organization_credentials_v1_responses-examples\} 200 ```json { "message": "ipsum eiusmod" } ``` ### Responses \{#operation-connector_delete_organization_credentials_v1_responses\} 200 Successful Response ##### message \{#operation-connector_delete_organization_credentials_v1_responses_200_application-json_message\} ## DELETE /v1/connectors/\{connector\_id\_or\_name\}/workspace/credentials/\{credentials\_name\} \{#operation-connector_delete_workspace_credentials_v1\} _Delete workspace credentials for a connector._ Delete credentials at the workspace level for a given connector. cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/workspace/credentials/{credentials_name} \ -X DELETE \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' \ -H 'Content-Type: application/json' ```
### Parameters \{#operation-connector_delete_workspace_credentials_v1_parameters\} ##### credentials_name \{#operation-connector_delete_workspace_credentials_v1_parameters_credentials_name\} ##### connector_id_or_name \{#operation-connector_delete_workspace_credentials_v1_parameters_connector_id_or_name\}
### Responses Examples \{#operation-connector_delete_workspace_credentials_v1_responses-examples\} 200 ```json { "message": "ipsum eiusmod" } ``` ### Responses \{#operation-connector_delete_workspace_credentials_v1_responses\} 200 Successful Response ##### message \{#operation-connector_delete_workspace_credentials_v1_responses_200_application-json_message\} ## DELETE /v1/connectors/\{connector\_id\_or\_name\}/user/credentials/\{credentials\_name\} \{#operation-connector_delete_user_credentials_v1\} _Delete user credentials for a connector._ Delete credentials at the user level for a given connector. cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/user/credentials/{credentials_name} \ -X DELETE \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' \ -H 'Content-Type: application/json' ```
### Parameters \{#operation-connector_delete_user_credentials_v1_parameters\} ##### credentials_name \{#operation-connector_delete_user_credentials_v1_parameters_credentials_name\} ##### connector_id_or_name \{#operation-connector_delete_user_credentials_v1_parameters_connector_id_or_name\}
### Responses Examples \{#operation-connector_delete_user_credentials_v1_responses-examples\} 200 ```json { "message": "ipsum eiusmod" } ``` ### Responses \{#operation-connector_delete_user_credentials_v1_responses\} 200 Successful Response ##### message \{#operation-connector_delete_user_credentials_v1_responses_200_application-json_message\} ## GET /v1/connectors/\{connector\_id\_or\_name\}\#idOrName \{#operation-connector_get_v1\} _Get a connector._ Get a connector by its ID or name. Python ```python from mistralai.client import Mistral import os with Mistral( api_key=os.getenv("MISTRAL_API_KEY", ""), ) as mistral: res = mistral.beta.connectors.get(connector_id_or_name="", fetch_customer_data=False, fetch_connection_secrets=False) # Handle response print(res) ``` cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}#idOrName \ -X GET \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' ```
### Parameters \{#operation-connector_get_v1_parameters\} ##### fetch_customer_data \{#operation-connector_get_v1_parameters_fetch_customer_data\} Fetch the customer data associated with the connector (e.g. customer secrets / config). ##### fetch_connection_secrets \{#operation-connector_get_v1_parameters_fetch_connection_secrets\} Fetch the general connection secrets associated with the connector. ##### connector_id_or_name \{#operation-connector_get_v1_parameters_connector_id_or_name\}
### Responses Examples \{#operation-connector_get_v1_responses-examples\} 200 ```json { "created_at": "2025-10-07T20:56:01.974Z", "description": "ipsum eiusmod", "id": "consequat do", "modified_at": "2025-10-07T20:56:01.974Z", "name": "reprehenderit ut dolore" } ``` ### Responses \{#operation-connector_get_v1_responses\} 200 Successful Response ##### auth_type \{#operation-connector_get_v1_responses_200_application-json_auth_type\} ##### created_at \{#operation-connector_get_v1_responses_200_application-json_created_at\} ##### description \{#operation-connector_get_v1_responses_200_application-json_description\} ##### id \{#operation-connector_get_v1_responses_200_application-json_id\} ##### modified_at \{#operation-connector_get_v1_responses_200_application-json_modified_at\} ##### name \{#operation-connector_get_v1_responses_200_application-json_name\} ##### server \{#operation-connector_get_v1_responses_200_application-json_server\} integrations__schemas__api__tool__Tool","children":[{"label":"integrations__schemas__api__tool__Tool","linkedLabel":"integrations__schemas__api__tool__Tool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### tools \{#operation-connector_get_v1_responses_200_application-json_tools\} #### integrations\_\_schemas\_\_api\_\_tool\_\_Tool \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool\} ##### active \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_active\} ##### created_at \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_created_at\} ##### description \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_description\} ExecutionConfig","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[{"title":"required","variant":"warning"}]} hasExpandableContent={true} expandByDefault={false} > ##### execution_config \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_execution_config\} Not typed since mcp config can changed / not stable we allow all extra fields and this is a dict TODO: once mcp is stable, we need to type this #### ExecutionConfig \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_execution_config_executionconfig\} Not typed since mcp config can changed / not stable we allow all extra fields and this is a dict TODO: once mcp is stable, we need to type this ##### AdditionalProperties \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_execution_config_executionconfig_additionalproperties\} ##### type \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_execution_config_executionconfig_type\} ##### id \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_id\} ##### jsonschema \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_jsonschema\} integrations__schemas__turbine__ToolLocale","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### locale \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_locale\} #### integrations\_\_schemas\_\_turbine\_\_ToolLocale \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale\} ##### description \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_description\} ##### name \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_name\} ##### usage_sentence \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_usage_sentence\} ##### modified_at \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_modified_at\} ##### name \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_name\} ##### system_prompt \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_system_prompt\} ##### visibility \{#operation-connector_get_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_visibility\} ## DELETE /v1/connectors/\{connector\_id\}\#id \{#operation-connector_delete_v1\} _Delete a connector._ Delete a connector by its ID. Python ```python from mistralai.client import Mistral import os with Mistral( api_key=os.getenv("MISTRAL_API_KEY", ""), ) as mistral: res = mistral.beta.connectors.delete(connector_id="5c3269fe-6a18-4216-b1fb-b093005874cd") # Handle response print(res) ``` cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id}#id \ -X DELETE \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' \ -H 'Content-Type: application/json' ```
### Parameters \{#operation-connector_delete_v1_parameters\} ##### connector_id \{#operation-connector_delete_v1_parameters_connector_id\}
### Responses Examples \{#operation-connector_delete_v1_responses-examples\} 200 ```json { "message": "ipsum eiusmod" } ``` ### Responses \{#operation-connector_delete_v1_responses\} 200 Successful Response ##### message \{#operation-connector_delete_v1_responses_200_application-json_message\} ## PATCH /v1/connectors/\{connector\_id\}\#id \{#operation-connector_update_v1\} _Update a connector._ Update a connector by its ID. Python ```python from mistralai.client import Mistral import os with Mistral( api_key=os.getenv("MISTRAL_API_KEY", ""), ) as mistral: res = mistral.beta.connectors.update(connector_id="81d30634-113f-4dce-a89e-7786be2d8693") # Handle response print(res) ``` cURL ```curl curl https://api.mistral.ai/v1/connectors/{connector_id}#id \ -X PATCH \ -H 'Authorization: Bearer YOUR_APIKEY_HERE' \ -H 'Content-Type: application/json' \ -d '{}' ```
### Parameters \{#operation-connector_update_v1_parameters\} ##### connector_id \{#operation-connector_update_v1_parameters_connector_id\}
### Request Example \{#operation-connector_update_v1_request-examples\} ```json {} ```
### Request Body \{#operation-connector_update_v1_request\} AuthData","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### auth_data \{#operation-connector_update_v1_request_auth_data\} Optional additional authentication data for the connector. #### AuthData \{#operation-connector_update_v1_request_auth_data_authdata\} Optional additional authentication data for the connector. ##### client_id \{#operation-connector_update_v1_request_auth_data_authdata_client_id\} ##### client_secret \{#operation-connector_update_v1_request_auth_data_authdata_client_secret\} ##### connection_config \{#operation-connector_update_v1_request_connection_config\} Optional new connection config. ##### connection_secrets \{#operation-connector_update_v1_request_connection_secrets\} Optional new connection secrets ##### description \{#operation-connector_update_v1_request_description\} The description of the connector. ##### headers \{#operation-connector_update_v1_request_headers\} New headers for your mcp connector. ##### icon_url \{#operation-connector_update_v1_request_icon_url\} The optional url of the icon you want to associate to the connector. ##### name \{#operation-connector_update_v1_request_name\} The name of the connector. ##### server \{#operation-connector_update_v1_request_server\} New server url for your mcp connector. ##### system_prompt \{#operation-connector_update_v1_request_system_prompt\} Optional system prompt for the connector.
### Responses Examples \{#operation-connector_update_v1_responses-examples\} 200 ```json { "created_at": "2025-10-07T20:56:01.974Z", "description": "ipsum eiusmod", "id": "consequat do", "modified_at": "2025-10-07T20:56:01.974Z", "name": "reprehenderit ut dolore" } ``` ### Responses \{#operation-connector_update_v1_responses\} 200 Successful Response ##### auth_type \{#operation-connector_update_v1_responses_200_application-json_auth_type\} ##### created_at \{#operation-connector_update_v1_responses_200_application-json_created_at\} ##### description \{#operation-connector_update_v1_responses_200_application-json_description\} ##### id \{#operation-connector_update_v1_responses_200_application-json_id\} ##### modified_at \{#operation-connector_update_v1_responses_200_application-json_modified_at\} ##### name \{#operation-connector_update_v1_responses_200_application-json_name\} ##### server \{#operation-connector_update_v1_responses_200_application-json_server\} integrations__schemas__api__tool__Tool","children":[{"label":"integrations__schemas__api__tool__Tool","linkedLabel":"integrations__schemas__api__tool__Tool","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### tools \{#operation-connector_update_v1_responses_200_application-json_tools\} #### integrations\_\_schemas\_\_api\_\_tool\_\_Tool \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool\} ##### active \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_active\} ##### created_at \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_created_at\} ##### description \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_description\} ExecutionConfig","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[{"title":"required","variant":"warning"}]} hasExpandableContent={true} expandByDefault={false} > ##### execution_config \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_execution_config\} Not typed since mcp config can changed / not stable we allow all extra fields and this is a dict TODO: once mcp is stable, we need to type this #### ExecutionConfig \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_execution_config_executionconfig\} Not typed since mcp config can changed / not stable we allow all extra fields and this is a dict TODO: once mcp is stable, we need to type this ##### AdditionalProperties \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_execution_config_executionconfig_additionalproperties\} ##### type \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_execution_config_executionconfig_type\} ##### id \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_id\} ##### jsonschema \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_jsonschema\} integrations__schemas__turbine__ToolLocale","children":[],"breakoutSubTypes":{}},{"label":"null","linkedLabel":"null","children":[],"breakoutSubTypes":{}}],"breakoutSubTypes":{}}} typeAnnotations={[]} hasExpandableContent={true} expandByDefault={false} > ##### locale \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_locale\} #### integrations\_\_schemas\_\_turbine\_\_ToolLocale \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale\} ##### description \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_description\} ##### name \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_name\} ##### usage_sentence \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_locale_integrations__schemas__turbine__toollocale_usage_sentence\} ##### modified_at \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_modified_at\} ##### name \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_name\} ##### system_prompt \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_system_prompt\} ##### visibility \{#operation-connector_update_v1_responses_200_application-json_tools_integrations__schemas__api__tool__tool_visibility\}