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.













(beta) Connectors API - manage your connectors












Real world code examples
List all connectors.
List all your custom connectors with keyset pagination and filters.
200
Successful Response
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.list({});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.list({});
console.log(result);
}
run();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)
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 https://api.mistral.ai/v1/connectors \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/connectors \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"items": [
{
"created_at": "2025-12-17T10:25:07.818693Z",
"description": "My resource description.",
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"modified_at": "2025-12-17T10:41:03.469341Z",
"name": "My resource",
"owner_type": "user",
"private_tool_execution": false,
"protocol": "occaecat dolor sit",
"supports_mcp": false,
"visibility": "shared_global"
}
],
"pagination": {
"page_size": "1000"
}
}{
"items": [
{
"created_at": "2025-12-17T10:25:07.818693Z",
"description": "My resource description.",
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"modified_at": "2025-12-17T10:41:03.469341Z",
"name": "My resource",
"owner_type": "user",
"private_tool_execution": false,
"protocol": "occaecat dolor sit",
"supports_mcp": false,
"visibility": "shared_global"
}
],
"pagination": {
"page_size": "1000"
}
}Create a new connector.
Create a new MCP or HTTP connector. You can customize its visibility, URL, and auth type.
201
Successful Response
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.create({
name: "<value>",
description: "unibody usually despite slushy wherever reward stingy from",
server: "https://royal-majority.net/",
protocol: "mcp",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.create({
name: "<value>",
description: "unibody usually despite slushy wherever reward stingy from",
server: "https://royal-majority.net/",
protocol: "mcp",
});
console.log(result);
}
run();from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.create(name="<value>", description="unibody usually despite slushy wherever reward stingy from", server="https://royal-majority.net/")
# Handle response
print(res)
from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.create(name="<value>", description="unibody usually despite slushy wherever reward stingy from", server="https://royal-majority.net/")
# Handle response
print(res)
curl https://api.mistral.ai/v1/connectors \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"description": "My resource description.",
"name": "My resource",
"server": "https://mcp.example.com"
}'curl https://api.mistral.ai/v1/connectors \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"description": "My resource description.",
"name": "My resource",
"server": "https://mcp.example.com"
}'201
{
"created_at": "2025-12-17T10:25:07.818693Z",
"description": "My resource description.",
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"modified_at": "2025-12-17T10:41:03.469341Z",
"name": "My resource",
"owner_type": "user",
"private_tool_execution": false,
"protocol": "occaecat dolor sit",
"supports_mcp": false,
"visibility": "shared_global"
}{
"created_at": "2025-12-17T10:25:07.818693Z",
"description": "My resource description.",
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"modified_at": "2025-12-17T10:41:03.469341Z",
"name": "My resource",
"owner_type": "user",
"private_tool_execution": false,
"protocol": "occaecat dolor sit",
"supports_mcp": false,
"visibility": "shared_global"
}Get the auth URL for a connector.
Get the OAuth2 authorization URL for a connector to initiate user authentication.
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.getAuthUrl({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.getAuthUrl({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.get_auth_url(connector_id_or_name="<value>", github_installation_link=False)
# Handle response
print(res)
from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.get_auth_url(connector_id_or_name="<value>", github_installation_link=False)
# Handle response
print(res)
curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/auth_url \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/auth_url \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"auth_url": "https://auth.example.com/oauth/authorize",
"ttl": 87
}{
"auth_url": "https://auth.example.com/oauth/authorize",
"ttl": 87
}Share a private connector to the current workspace.
Transfers ownership of a private user-owned connector to the current workspace, making it available to all workspace members. The creator can later revert this via the unshare endpoint. Any authentication flows that rely on the original owner's identity (e.g. OAuth on-behalf-of) will be affected and must be reconfigured after sharing. Only the connector's creator can call this endpoint. Requires the ShareConnectorToWorkspace workspace permission.
200
Successful Response
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.share({
connectorId: "cf748b50-632b-46d6-98c3-b015086cb194",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.share({
connectorId: "cf748b50-632b-46d6-98c3-b015086cb194",
});
console.log(result);
}
run();from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.share(connector_id="cf748b50-632b-46d6-98c3-b015086cb194")
# Handle response
print(res)
from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.share(connector_id="cf748b50-632b-46d6-98c3-b015086cb194")
# Handle response
print(res)
curl https://api.mistral.ai/v1/connectors/{connector_id}/share \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/connectors/{connector_id}/share \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'200
{
"message": "Example message."
}{
"message": "Example message."
}Unshare a connector from the current workspace.
Reverts a workspace-shared connector back to a private, creator-owned connector. Workspace-scoped connections and other members' connections are removed; the creator's own connection is preserved. Only the connector's creator can call this endpoint. Requires the ShareConnectorToWorkspace workspace permission.
200
Successful Response
Test the endpoints live
curl https://api.mistral.ai/v1/connectors/{connector_id}/share \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/connectors/{connector_id}/share \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.unshare({
connectorId: "d5bd99ac-c46d-43bb-835c-cb4833bf101d",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.unshare({
connectorId: "d5bd99ac-c46d-43bb-835c-cb4833bf101d",
});
console.log(result);
}
run();200
{
"message": "Example message."
}{
"message": "Example message."
}Share a connector to the current organization.
Transfers ownership of a private user-owned connector to the current organization, making it available to all organization members. The creator can later revert this via the unshare endpoint. Any authentication flows that rely on the original owner's identity (e.g. OAuth on-behalf-of) will be affected and must be reconfigured after sharing. Requires the ShareConnectorToOrg organization permission.
200
Successful Response
Test the endpoints live
curl https://api.mistral.ai/v1/connectors/{connector_id}/organization/share \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/connectors/{connector_id}/organization/share \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.shareToOrganization({
connectorId: "9dc7017e-ae2f-451c-9b03-623aab4aecde",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.shareToOrganization({
connectorId: "9dc7017e-ae2f-451c-9b03-623aab4aecde",
});
console.log(result);
}
run();200
{
"message": "Example message."
}{
"message": "Example message."
}Unshare a connector from the current organization.
Reverts an organization-shared connector back to a private, creator-owned connector. Organization-scoped connections and other members' connections are removed; the creator's own connection is preserved. Requires the ShareConnectorToOrg organization permission.
200
Successful Response
Test the endpoints live
curl https://api.mistral.ai/v1/connectors/{connector_id}/organization/share \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/connectors/{connector_id}/organization/share \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.unshareFromOrganization({
connectorId: "def26f6b-c03a-4deb-9726-3771c1dd3388",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.unshareFromOrganization({
connectorId: "def26f6b-c03a-4deb-9726-3771c1dd3388",
});
console.log(result);
}
run();200
{
"message": "Example message."
}{
"message": "Example message."
}Activate a connector for the given consumer (organization, workspace, user).
Enable a connector for the consumer.
200
Successful Response
Test the endpoints live
curl https://api.mistral.ai/v1/connectors/{connector_id}/{consumer_scope}/activate \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/connectors/{connector_id}/{consumer_scope}/activate \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.activateForConsumer({
connectorId: "1637d954-8ef0-4080-9228-89d4c05c915f",
consumerScope: "workspace",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.activateForConsumer({
connectorId: "1637d954-8ef0-4080-9228-89d4c05c915f",
consumerScope: "workspace",
});
console.log(result);
}
run();200
{
"message": "Example message."
}{
"message": "Example message."
}Deactivate a connector for the current consumer (at organization, workspace or user level).
Disable a connector for the calling consumer only.
200
Successful Response
Test the endpoints live
curl https://api.mistral.ai/v1/connectors/{connector_id}/{consumer_scope}/deactivate \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/connectors/{connector_id}/{consumer_scope}/deactivate \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.deactivateForConsumer({
connectorId: "1266a170-0379-4b3f-9305-d10fd2a83d29",
consumerScope: "workspace",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.deactivateForConsumer({
connectorId: "1266a170-0379-4b3f-9305-d10fd2a83d29",
consumerScope: "workspace",
});
console.log(result);
}
run();200
{
"message": "Example message."
}{
"message": "Example message."
}Call Connector Tool
Call a tool on an MCP connector.
Request body for calling an MCP tool.
200
Successful Response
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.
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.callTool({
toolName: "<value>",
connectorIdOrName: "<value>",
connectorCallToolRequest: {},
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.callTool({
toolName: "<value>",
connectorIdOrName: "<value>",
connectorCallToolRequest: {},
});
console.log(result);
}
run();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="<value>", connector_id_or_name="<value>")
# Handle response
print(res)
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="<value>", connector_id_or_name="<value>")
# Handle response
print(res)
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 '{}'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 '{}'200
{
"content": [
{
"text": "Example text.",
"type": "document"
}
]
}{
"content": [
{
"text": "Example text.",
"type": "document"
}
]
}List tools for a connector.
List all tools available for an MCP connector.
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.listTools({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.listTools({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.list_tools(connector_id_or_name="<value>", page=1, page_size=100, refresh=False, pretty=False)
# Handle response
print(res)
from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.list_tools(connector_id_or_name="<value>", page=1, page_size=100, refresh=False, pretty=False)
# Handle response
print(res)
curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/tools \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/tools \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
[
{
"inputSchema": [
null
],
"name": "My resource"
}
][
{
"inputSchema": [
null
],
"name": "My resource"
}
]Get authentication methods for a connector.
Get the authentication schema for a connector. Returns the list of supported authentication methods and their required headers.
200
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.getAuthenticationMethods({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.getAuthenticationMethods({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.get_authentication_methods(connector_id_or_name="<value>")
# Handle response
print(res)
from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.get_authentication_methods(connector_id_or_name="<value>")
# Handle response
print(res)
curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/authentication_methods \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/authentication_methods \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
nullnullList organization credentials for a connector.
List all credentials configured at the organization level for a given connector.
200
Successful Response
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.listOrganizationCredentials({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.listOrganizationCredentials({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.list_organization_credentials(connector_id_or_name="<value>", fetch_default=False)
# Handle response
print(res)
from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.list_organization_credentials(connector_id_or_name="<value>", fetch_default=False)
# Handle response
print(res)
curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/organization/credentials \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/organization/credentials \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"credentials": null
}{
"credentials": null
}List workspace credentials for a connector.
List all credentials configured at the workspace level for a given connector.
200
Successful Response
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.listWorkspaceCredentials({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.listWorkspaceCredentials({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.list_workspace_credentials(connector_id_or_name="<value>", fetch_default=False)
# Handle response
print(res)
from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.list_workspace_credentials(connector_id_or_name="<value>", fetch_default=False)
# Handle response
print(res)
curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/workspace/credentials \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/workspace/credentials \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"credentials": null
}{
"credentials": null
}List user credentials for a connector.
List all credentials configured at the user level for a given connector.
200
Successful Response
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.listUserCredentials({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.listUserCredentials({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.list_user_credentials(connector_id_or_name="<value>", fetch_default=False)
# Handle response
print(res)
from mistralai.client import Mistral
import os
with Mistral(
api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:
res = mistral.beta.connectors.list_user_credentials(connector_id_or_name="<value>", fetch_default=False)
# Handle response
print(res)
curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/user/credentials \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/user/credentials \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"credentials": null
}{
"credentials": null
}Delete all user credentials for a connector.
Delete all credentials configured at the user level for a given connector.
200
Successful Response
Test the endpoints live
curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/user/credentials \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/user/credentials \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.deleteAllUserCredentials({
connectorIdOrName: "5d332e4a-b496-4634-bfa5-8233e837b143",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.deleteAllUserCredentials({
connectorIdOrName: "5d332e4a-b496-4634-bfa5-8233e837b143",
});
console.log(result);
}
run();200
{
"message": "Example message."
}{
"message": "Example message."
}Create consumer credentials for a connector.
Create consumer credentials for a given connector and consumer scope (organization, workspace, user)
Request to create or update credentials for a connector.
The credential data (headers, bearer_token, or OAuth2 client credentials).
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.
Human-readable title for the credentials.
200
Successful Response
Test the endpoints live
curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/{consumer_scope}/credentials \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"name": "My resource"
}'curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/{consumer_scope}/credentials \
-X POST \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"name": "My resource"
}'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.createCredentials({
connectorIdOrName: "b7170011-bca4-40c2-8f3d-4f646a544062",
consumerScope: "organization",
credentialsCreateOrUpdate: {
name: "<value>",
},
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.createCredentials({
connectorIdOrName: "b7170011-bca4-40c2-8f3d-4f646a544062",
consumerScope: "organization",
credentialsCreateOrUpdate: {
name: "<value>",
},
});
console.log(result);
}
run();200
{
"message": "Example message."
}{
"message": "Example message."
}Create or update consumer credentials for a connector.
Create or update consumer credentials for a given connector.
Request to create or update credentials for a connector.
The credential data (headers, bearer_token, or OAuth2 client credentials).
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.
Human-readable title for the credentials.
200
Successful Response
Test the endpoints live
curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/{consumer_scope}/credentials \
-X PATCH \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"name": "My resource"
}'curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/{consumer_scope}/credentials \
-X PATCH \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"name": "My resource"
}'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.updateCredentials({
connectorIdOrName: "7b7eceb1-b6c5-44e4-8382-f2bba1886c77",
consumerScope: "workspace",
credentialsCreateOrUpdate: {
name: "<value>",
},
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.updateCredentials({
connectorIdOrName: "7b7eceb1-b6c5-44e4-8382-f2bba1886c77",
consumerScope: "workspace",
credentialsCreateOrUpdate: {
name: "<value>",
},
});
console.log(result);
}
run();200
{
"message": "Example message."
}{
"message": "Example message."
}Delete credentials for a consumer.
Delete connector credentials for a given consumer.
200
Successful Response
Test the endpoints live
curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/{consumer_scope}/credentials/{credentials_name} \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}/{consumer_scope}/credentials/{credentials_name} \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.deleteCredentials({
credentialsName: "<value>",
connectorIdOrName: "0f7c9a94-b4f7-44d9-aa77-e9f28f561e03",
consumerScope: "user",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.deleteCredentials({
credentialsName: "<value>",
connectorIdOrName: "0f7c9a94-b4f7-44d9-aa77-e9f28f561e03",
consumerScope: "user",
});
console.log(result);
}
run();200
{
"message": "Example message."
}{
"message": "Example message."
}Get a connector.
Get a connector by its ID or name.
200
Successful Response
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.get({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.get({
connectorIdOrName: "<value>",
});
console.log(result);
}
run();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="<value>", fetch_user_data=False, fetch_customer_data=False)
# Handle response
print(res)
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="<value>", fetch_user_data=False, fetch_customer_data=False)
# Handle response
print(res)
curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}#idOrName \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/connectors/{connector_id_or_name}#idOrName \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"created_at": "2025-12-17T10:25:07.818693Z",
"description": "My resource description.",
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"modified_at": "2025-12-17T10:41:03.469341Z",
"name": "My resource",
"owner_type": "user",
"private_tool_execution": false,
"protocol": "occaecat dolor sit",
"supports_mcp": false,
"visibility": "shared_global"
}{
"created_at": "2025-12-17T10:25:07.818693Z",
"description": "My resource description.",
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"modified_at": "2025-12-17T10:41:03.469341Z",
"name": "My resource",
"owner_type": "user",
"private_tool_execution": false,
"protocol": "occaecat dolor sit",
"supports_mcp": false,
"visibility": "shared_global"
}Delete a connector.
Delete a connector by its ID.
200
Successful Response
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.delete({
connectorId: "5c3269fe-6a18-4216-b1fb-b093005874cd",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.delete({
connectorId: "5c3269fe-6a18-4216-b1fb-b093005874cd",
});
console.log(result);
}
run();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)
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 https://api.mistral.ai/v1/connectors/{connector_id}#id \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/connectors/{connector_id}#id \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'200
{
"message": "Example message."
}{
"message": "Example message."
}Update a connector.
Update a connector by its ID.
200
Successful Response
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.update({
connectorId: "81d30634-113f-4dce-a89e-7786be2d8693",
requestBody: {
protocol: "mcp",
},
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.connectors.update({
connectorId: "81d30634-113f-4dce-a89e-7786be2d8693",
requestBody: {
protocol: "mcp",
},
});
console.log(result);
}
run();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)
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 https://api.mistral.ai/v1/connectors/{connector_id}#id \
-X PATCH \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{}'curl https://api.mistral.ai/v1/connectors/{connector_id}#id \
-X PATCH \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{}'200
{
"created_at": "2025-12-17T10:25:07.818693Z",
"description": "My resource description.",
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"modified_at": "2025-12-17T10:41:03.469341Z",
"name": "My resource",
"owner_type": "user",
"private_tool_execution": false,
"protocol": "occaecat dolor sit",
"supports_mcp": false,
"visibility": "shared_global"
}{
"created_at": "2025-12-17T10:25:07.818693Z",
"description": "My resource description.",
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"modified_at": "2025-12-17T10:41:03.469341Z",
"name": "My resource",
"owner_type": "user",
"private_tool_execution": false,
"protocol": "occaecat dolor sit",
"supports_mcp": false,
"visibility": "shared_global"
}