Beta Connectors Endpoints

(beta) Connectors API - manage your connectors

List all connectors.

GET /v1/connectors

List all your custom connectors with keyset pagination and filters.

200

Successful Response

items

*array<Connector>

pagination

*PaginationResponse

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "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: "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": "1",
      "private_tool_execution": 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": "1",
      "private_tool_execution": false,
      "visibility": "shared_global"
    }
  ],
  "pagination": {
    "page_size": "1000"
  }
}

Create a new connector.

POST /v1/connectors

Create a new MCP connector. You can customize its visibility, url and auth type.

201

Successful Response

active

boolean|null

created_at

*date-time

creator_id

string|null

description

*string

execution_env

PublicExecutionEnv|null

Credentials-free projection of ExecutionEnv for the public /connectors/mistral response.

icon_url

string|null

id

*string

is_authenticated

boolean|null

locale

ConnectorLocale|null

mistral

boolean

Default Value: false

modified_at

*date-time

name

*string

owner_id

string|null

owner_type

*"1"|"2"|"3"|"4"

private_tool_execution

*boolean

protocol

"mcp"|"http"|"turbine"

server

string|null

server_card

MCPServerCard|null

supported_auth_methods

array<PublicAuthenticationMethod>|null

system_prompt

string|null

system_prompt_route

string|null

title

string|null

tools

array<ConnectorTool>|null

visibility

*"shared_global"|"shared_org"|"shared_workspace"|"private"

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "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/",
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "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/",
  });

  console.log(result);
}

run();

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

connector = client.beta.connectors.create(
    name="company_docs",
    description="Company documentation MCP connector",
    server="https://mcp.example.com",
)

print(connector.id)

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

connector = client.beta.connectors.create(
    name="company_docs",
    description="Company documentation MCP connector",
    server="https://mcp.example.com",
)

print(connector.id)

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": "1",
  "private_tool_execution": 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": "1",
  "private_tool_execution": false,
  "visibility": "shared_global"
}

Get the auth URL for a connector.

GET /v1/connectors/{connector_id_or_name}/auth_url

Get the OAuth2 authorization URL for a connector to initiate user authentication.

200

Successful Response

auth_url

*string

ttl

*integer

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "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: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.getAuthUrl({
    connectorIdOrName: "<value>",
  });

  console.log(result);
}

run();

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

auth_url = client.beta.connectors.get_auth_url(
    connector_id_or_name="company_docs",
    credentials_name="production",
)

print(auth_url.auth_url)

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

auth_url = client.beta.connectors.get_auth_url(
    connector_id_or_name="company_docs",
    credentials_name="production",
)

print(auth_url.auth_url)

curl "https://api.mistral.ai/v1/connectors/company_docs/auth_url?credentials_name=production" \
  -H "Authorization: Bearer $MISTRAL_API_KEY"

curl "https://api.mistral.ai/v1/connectors/company_docs/auth_url?credentials_name=production" \
  -H "Authorization: Bearer $MISTRAL_API_KEY"

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.

PUT /v1/connectors/{connector_id}/share

Transfers ownership of a private user-owned connector to the current workspace, making it available to all workspace members. This action is irreversible: once shared, the connector belongs to the workspace and can no longer be used privately across other workspaces. 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

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "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: "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."
}

Activate a connector for an organization.

POST /v1/connectors/{connector_id}/organization/activate

Enable a connector at the organization level so all members can use it.

200

Successful Response

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.activateForOrganization({
    connectorId: "a91bb4ec-caab-4cf2-be03-84b8343f4643",
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.activateForOrganization({
    connectorId: "a91bb4ec-caab-4cf2-be03-84b8343f4643",
  });

  console.log(result);
}

run();

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

response = client.beta.connectors.activate_for_organization(
    connector_id="019b2bd7-96e7-7219-8c0b-45a73da50088",
    tool_configuration={
        "include": ["search"],
        "requires_confirmation": ["delete_document"],
        "skip_confirmation": ["read_document"],
    },
)

print(response.message)

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

response = client.beta.connectors.activate_for_organization(
    connector_id="019b2bd7-96e7-7219-8c0b-45a73da50088",
    tool_configuration={
        "include": ["search"],
        "requires_confirmation": ["delete_document"],
        "skip_confirmation": ["read_document"],
    },
)

print(response.message)

curl https://api.mistral.ai/v1/connectors/019b2bd7-96e7-7219-8c0b-45a73da50088/organization/activate \
  -X POST \
  -H "Authorization: Bearer $MISTRAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "include": ["search"],
    "requires_confirmation": ["delete_document"],
    "skip_confirmation": ["read_document"]
  }'

curl https://api.mistral.ai/v1/connectors/019b2bd7-96e7-7219-8c0b-45a73da50088/organization/activate \
  -X POST \
  -H "Authorization: Bearer $MISTRAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "include": ["search"],
    "requires_confirmation": ["delete_document"],
    "skip_confirmation": ["read_document"]
  }'

200

{
  "message": "Example message."
}

{
  "message": "Example message."
}

Deactivate a connector for an organization.

POST /v1/connectors/{connector_id}/organization/deactivate

Disable a connector at the organization level.

200

Successful Response

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.deactivateForOrganization({
    connectorId: "8f4c1089-2a37-44b3-a3c4-830ca7a0e439",
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.deactivateForOrganization({
    connectorId: "8f4c1089-2a37-44b3-a3c4-830ca7a0e439",
  });

  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.deactivate_for_organization(connector_id="8f4c1089-2a37-44b3-a3c4-830ca7a0e439")

    # 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.deactivate_for_organization(connector_id="8f4c1089-2a37-44b3-a3c4-830ca7a0e439")

    # Handle response
    print(res)

curl https://api.mistral.ai/v1/connectors/{connector_id}/organization/deactivate \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

curl https://api.mistral.ai/v1/connectors/{connector_id}/organization/deactivate \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

200

{
  "message": "Example message."
}

{
  "message": "Example message."
}

Activate a connector for a workspace.

POST /v1/connectors/{connector_id}/workspace/activate

Enable a connector at the workspace level so all members of the workspace can use it.

200

Successful Response

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.activateForWorkspace({
    connectorId: "2adfa8af-3618-41a9-8980-e5ea1486e58e",
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.activateForWorkspace({
    connectorId: "2adfa8af-3618-41a9-8980-e5ea1486e58e",
  });

  console.log(result);
}

run();

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

response = client.beta.connectors.activate_for_workspace(
    connector_id="019b2bd7-96e7-7219-8c0b-45a73da50088",
    tool_configuration={
        "include": ["search"],
        "requires_confirmation": ["delete_document"],
        "skip_confirmation": ["read_document"],
    },
)

print(response.message)

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

response = client.beta.connectors.activate_for_workspace(
    connector_id="019b2bd7-96e7-7219-8c0b-45a73da50088",
    tool_configuration={
        "include": ["search"],
        "requires_confirmation": ["delete_document"],
        "skip_confirmation": ["read_document"],
    },
)

print(response.message)

curl https://api.mistral.ai/v1/connectors/019b2bd7-96e7-7219-8c0b-45a73da50088/workspace/activate \
  -X POST \
  -H "Authorization: Bearer $MISTRAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "include": ["search"],
    "requires_confirmation": ["delete_document"],
    "skip_confirmation": ["read_document"]
  }'

curl https://api.mistral.ai/v1/connectors/019b2bd7-96e7-7219-8c0b-45a73da50088/workspace/activate \
  -X POST \
  -H "Authorization: Bearer $MISTRAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "include": ["search"],
    "requires_confirmation": ["delete_document"],
    "skip_confirmation": ["read_document"]
  }'

200

{
  "message": "Example message."
}

{
  "message": "Example message."
}

Deactivate a connector for a workspace.

POST /v1/connectors/{connector_id}/workspace/deactivate

Disable a connector at the workspace level.

200

Successful Response

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.deactivateForWorkspace({
    connectorId: "15b00e98-a9e7-4582-b0fc-87d28c3dac04",
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.deactivateForWorkspace({
    connectorId: "15b00e98-a9e7-4582-b0fc-87d28c3dac04",
  });

  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.deactivate_for_workspace(connector_id="15b00e98-a9e7-4582-b0fc-87d28c3dac04")

    # 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.deactivate_for_workspace(connector_id="15b00e98-a9e7-4582-b0fc-87d28c3dac04")

    # Handle response
    print(res)

curl https://api.mistral.ai/v1/connectors/{connector_id}/workspace/deactivate \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

curl https://api.mistral.ai/v1/connectors/{connector_id}/workspace/deactivate \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

200

{
  "message": "Example message."
}

{
  "message": "Example message."
}

Activate a connector for the current user.

POST /v1/connectors/{connector_id}/user/activate

Enable a connector for the calling user only.

200

Successful Response

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.activateForUser({
    connectorId: "cd4fb4d2-de68-451f-8f2a-57fe39b33d96",
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.activateForUser({
    connectorId: "cd4fb4d2-de68-451f-8f2a-57fe39b33d96",
  });

  console.log(result);
}

run();

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

response = client.beta.connectors.activate_for_user(
    connector_id="019b2bd7-96e7-7219-8c0b-45a73da50088",
    tool_configuration={
        "include": ["search"],
        "requires_confirmation": ["delete_document"],
        "skip_confirmation": ["read_document"],
    },
)

print(response.message)

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

response = client.beta.connectors.activate_for_user(
    connector_id="019b2bd7-96e7-7219-8c0b-45a73da50088",
    tool_configuration={
        "include": ["search"],
        "requires_confirmation": ["delete_document"],
        "skip_confirmation": ["read_document"],
    },
)

print(response.message)

curl https://api.mistral.ai/v1/connectors/019b2bd7-96e7-7219-8c0b-45a73da50088/user/activate \
  -X POST \
  -H "Authorization: Bearer $MISTRAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "include": ["search"],
    "requires_confirmation": ["delete_document"],
    "skip_confirmation": ["read_document"]
  }'

curl https://api.mistral.ai/v1/connectors/019b2bd7-96e7-7219-8c0b-45a73da50088/user/activate \
  -X POST \
  -H "Authorization: Bearer $MISTRAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "include": ["search"],
    "requires_confirmation": ["delete_document"],
    "skip_confirmation": ["read_document"]
  }'

200

{
  "message": "Example message."
}

{
  "message": "Example message."
}

Deactivate a connector for the current user.

POST /v1/connectors/{connector_id}/user/deactivate

Disable a connector for the calling user only.

200

Successful Response

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.deactivateForUser({
    connectorId: "99c6ed86-e6bb-40ed-b6ee-d22ba791a68f",
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.deactivateForUser({
    connectorId: "99c6ed86-e6bb-40ed-b6ee-d22ba791a68f",
  });

  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.deactivate_for_user(connector_id="99c6ed86-e6bb-40ed-b6ee-d22ba791a68f")

    # 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.deactivate_for_user(connector_id="99c6ed86-e6bb-40ed-b6ee-d22ba791a68f")

    # Handle response
    print(res)

curl https://api.mistral.ai/v1/connectors/{connector_id}/user/deactivate \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

curl https://api.mistral.ai/v1/connectors/{connector_id}/user/deactivate \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

200

{
  "message": "Example message."
}

{
  "message": "Example message."
}

Call Connector Tool

POST /v1/connectors/{connector_id_or_name}/tools/{tool_name}/call

Call a tool on an MCP connector.

200

Successful Response

AdditionalProperties

map<any>

content

*array<TextContent|ImageContent|AudioContent|ResourceLink|EmbeddedResource>

metadata

ConnectorToolCallMetadata|null

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.

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "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: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.callTool({
    toolName: "<value>",
    connectorIdOrName: "<value>",
    connectorCallToolRequest: {},
  });

  console.log(result);
}

run();

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

result = client.beta.connectors.call_tool(
    connector_id_or_name="company_docs",
    tool_name="search",
)

print(result)

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

result = client.beta.connectors.call_tool(
    connector_id_or_name="company_docs",
    tool_name="search",
)

print(result)

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.

GET /v1/connectors/{connector_id_or_name}/tools

List all tools available for an MCP connector.

200

Response Type

array<ConnectorTool>|null|array<MCPTool>|array<map<any>>

Successful Response

ConnectorTool

{object}

MCPTool

{object}

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "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: "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

null

null

Get authentication methods for a connector.

GET /v1/connectors/{connector_id_or_name}/authentication_methods

Get the authentication schema for a connector. Returns the list of supported authentication methods and their required headers.

200

Response Type

array<PublicAuthenticationMethod>|null

Successful Response

PublicAuthenticationMethod

{object}

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "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: "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

null

null

List organization credentials for a connector.

GET /v1/connectors/{connector_id_or_name}/organization/credentials

List all credentials configured at the organization level for a given connector.

200

Successful Response

connector_preset_credentials_for_auth

array<"oauth2"|"bearer"|"none"|"github_app"|"slack_app">

credentials

*array<AuthenticationConfiguration>|null

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "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: "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
}

Create or update organization credentials for a connector.

POST /v1/connectors/{connector_id_or_name}/organization/credentials

Create or update credentials at the organization level for a given connector.

200

Successful Response

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.createOrUpdateOrganizationCredentials({
    connectorIdOrName: "<value>",
    credentialsCreateOrUpdate: {
      name: "<value>",
    },
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.createOrUpdateOrganizationCredentials({
    connectorIdOrName: "<value>",
    credentialsCreateOrUpdate: {
      name: "<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.create_or_update_organization_credentials(connector_id_or_name="<value>", 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.create_or_update_organization_credentials(connector_id_or_name="<value>", name="<value>")

    # Handle response
    print(res)

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": "My resource"
}'

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": "My resource"
}'

200

{
  "message": "Example message."
}

{
  "message": "Example message."
}

List workspace credentials for a connector.

GET /v1/connectors/{connector_id_or_name}/workspace/credentials

List all credentials configured at the workspace level for a given connector.

200

Successful Response

connector_preset_credentials_for_auth

array<"oauth2"|"bearer"|"none"|"github_app"|"slack_app">

credentials

*array<AuthenticationConfiguration>|null

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "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: "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
}

Create or update workspace credentials for a connector.

POST /v1/connectors/{connector_id_or_name}/workspace/credentials

Create or update credentials at the workspace level for a given connector.

200

Successful Response

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.createOrUpdateWorkspaceCredentials({
    connectorIdOrName: "<value>",
    credentialsCreateOrUpdate: {
      name: "<value>",
    },
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.createOrUpdateWorkspaceCredentials({
    connectorIdOrName: "<value>",
    credentialsCreateOrUpdate: {
      name: "<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.create_or_update_workspace_credentials(connector_id_or_name="<value>", 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.create_or_update_workspace_credentials(connector_id_or_name="<value>", name="<value>")

    # Handle response
    print(res)

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": "My resource"
}'

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": "My resource"
}'

200

{
  "message": "Example message."
}

{
  "message": "Example message."
}

List user credentials for a connector.

GET /v1/connectors/{connector_id_or_name}/user/credentials

List all credentials configured at the user level for a given connector.

200

Successful Response

connector_preset_credentials_for_auth

array<"oauth2"|"bearer"|"none"|"github_app"|"slack_app">

credentials

*array<AuthenticationConfiguration>|null

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "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: "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
}

Create or update user credentials for a connector.

POST /v1/connectors/{connector_id_or_name}/user/credentials

Create or update credentials at the user level for a given connector.

200

Successful Response

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.createOrUpdateUserCredentials({
    connectorIdOrName: "<value>",
    credentialsCreateOrUpdate: {
      name: "<value>",
    },
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.createOrUpdateUserCredentials({
    connectorIdOrName: "<value>",
    credentialsCreateOrUpdate: {
      name: "<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.create_or_update_user_credentials(connector_id_or_name="<value>", 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.create_or_update_user_credentials(connector_id_or_name="<value>", name="<value>")

    # Handle response
    print(res)

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": "My resource"
}'

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": "My resource"
}'

200

{
  "message": "Example message."
}

{
  "message": "Example message."
}

Delete all user credentials for a connector.

DELETE /v1/connectors/{connector_id_or_name}/user/credentials

Delete all credentials configured at the user level for a given connector.

200

Successful Response

message

*string

Playground

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'

200

{
  "message": "Example message."
}

{
  "message": "Example message."
}

Delete organization credentials for a connector.

DELETE /v1/connectors/{connector_id_or_name}/organization/credentials/{credentials_name}

Delete credentials at the organization level for a given connector.

200

Successful Response

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.deleteOrganizationCredentials({
    credentialsName: "<value>",
    connectorIdOrName: "<value>",
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.deleteOrganizationCredentials({
    credentialsName: "<value>",
    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.delete_organization_credentials(credentials_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.delete_organization_credentials(credentials_name="<value>", connector_id_or_name="<value>")

    # Handle response
    print(res)

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'

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'

200

{
  "message": "Example message."
}

{
  "message": "Example message."
}

Delete workspace credentials for a connector.

DELETE /v1/connectors/{connector_id_or_name}/workspace/credentials/{credentials_name}

Delete credentials at the workspace level for a given connector.

200

Successful Response

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.deleteWorkspaceCredentials({
    credentialsName: "<value>",
    connectorIdOrName: "<value>",
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.deleteWorkspaceCredentials({
    credentialsName: "<value>",
    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.delete_workspace_credentials(credentials_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.delete_workspace_credentials(credentials_name="<value>", connector_id_or_name="<value>")

    # Handle response
    print(res)

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'

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'

200

{
  "message": "Example message."
}

{
  "message": "Example message."
}

Delete user credentials for a connector.

DELETE /v1/connectors/{connector_id_or_name}/user/credentials/{credentials_name}

Delete credentials at the user level for a given connector.

200

Successful Response

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.deleteUserCredentials({
    credentialsName: "<value>",
    connectorIdOrName: "<value>",
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.deleteUserCredentials({
    credentialsName: "<value>",
    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.delete_user_credentials(credentials_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.delete_user_credentials(credentials_name="<value>", connector_id_or_name="<value>")

    # Handle response
    print(res)

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'

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'

200

{
  "message": "Example message."
}

{
  "message": "Example message."
}

Get a connector.

GET /v1/connectors/{connector_id_or_name}#idOrName

Get a connector by its ID or name.

200

Successful Response

active

boolean|null

connection_config

PublicConnectionConfig|null

connection_credentials

array<AuthenticationConfiguration>|null

connection_preferences

array<ConnectionPreference>|null

created_at

*date-time

creator_id

string|null

description

*string

execution_env

PublicExecutionEnv|null

Credentials-free projection of ExecutionEnv for the public /connectors/mistral response.

icon_url

string|null

id

*string

is_authenticated

boolean|null

locale

ConnectorLocale|null

mistral

boolean

Default Value: false

modified_at

*date-time

name

*string

owner_id

string|null

owner_type

*"1"|"2"|"3"|"4"

private_tool_execution

*boolean

protocol

"mcp"|"http"|"turbine"

server

string|null

server_card

MCPServerCard|null

supported_auth_methods

array<PublicAuthenticationMethod>|null

system_prompt

string|null

system_prompt_route

string|null

title

string|null

tools

array<ConnectorTool>|null

visibility

*"shared_global"|"shared_org"|"shared_workspace"|"private"

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "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: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.get({
    connectorIdOrName: "<value>",
  });

  console.log(result);
}

run();

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

connector = client.beta.connectors.get(
    connector_id_or_name="company_docs",
    fetch_customer_data=False,
    fetch_connection_secrets=False,
)

print(connector.name)

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

connector = client.beta.connectors.get(
    connector_id_or_name="company_docs",
    fetch_customer_data=False,
    fetch_connection_secrets=False,
)

print(connector.name)

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": "1",
  "private_tool_execution": 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": "1",
  "private_tool_execution": false,
  "visibility": "shared_global"
}

Delete a connector.

DELETE /v1/connectors/{connector_id}#id

Delete a connector by its ID.

200

Successful Response

message

*string

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "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: "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.

PATCH /v1/connectors/{connector_id}#id

Update a connector by its ID.

200

Successful Response

active

boolean|null

connection_config

PublicConnectionConfig|null

connection_credentials

array<AuthenticationConfiguration>|null

connection_preferences

array<ConnectionPreference>|null

created_at

*date-time

creator_id

string|null

description

*string

execution_env

PublicExecutionEnv|null

Credentials-free projection of ExecutionEnv for the public /connectors/mistral response.

icon_url

string|null

id

*string

is_authenticated

boolean|null

locale

ConnectorLocale|null

mistral

boolean

Default Value: false

modified_at

*date-time

name

*string

owner_id

string|null

owner_type

*"1"|"2"|"3"|"4"

private_tool_execution

*boolean

protocol

"mcp"|"http"|"turbine"

server

string|null

server_card

MCPServerCard|null

supported_auth_methods

array<PublicAuthenticationMethod>|null

system_prompt

string|null

system_prompt_route

string|null

title

string|null

tools

array<ConnectorTool>|null

visibility

*"shared_global"|"shared_org"|"shared_workspace"|"private"

Playground

Test the endpoints live

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.update({
    connectorId: "81d30634-113f-4dce-a89e-7786be2d8693",
    updateConnectorRequest: {},
  });

  console.log(result);
}

run();

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.beta.connectors.update({
    connectorId: "81d30634-113f-4dce-a89e-7786be2d8693",
    updateConnectorRequest: {},
  });

  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": "1",
  "private_tool_execution": 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": "1",
  "private_tool_execution": false,
  "visibility": "shared_global"
}

Beta Connectors Endpoints

Examples

GET /v1/connectors

Parameters

query_filters

cursor

page_size

items

pagination

Playground

POST /v1/connectors

Request Body

auth_data

description

headers

icon_url

name

oauth2_server_metadata

oauth2_server_metadata_url

protocol

server

system_prompt

title

visibility

active

connection_config

connection_credentials

connection_preferences

created_at

creator_id

description

execution_env

icon_url

id

is_authenticated

locale

mistral

modified_at

name

owner_id

owner_type

private_tool_execution

protocol

server

server_card

supported_auth_methods

system_prompt

system_prompt_route

title

tools

visibility

Playground

GET /v1/connectors/{connector_id_or_name}/auth_url

auth_url

ttl

Playground

PUT /v1/connectors/{connector_id}/share

Parameters

connector_id

message

Playground

POST /v1/connectors/{connector_id}/organization/activate

Parameters

connector_id

Request Body

exclude

include

requires_confirmation

skip_confirmation

message

Playground

POST /v1/connectors/{connector_id}/organization/deactivate

Parameters

connector_id

message

Playground

POST /v1/connectors/{connector_id}/workspace/activate

Parameters

connector_id

Request Body