Number of organizations to skip before returning results.
Beta Users Endpoints
(beta) Users API.
Examples
Real world code examples
Get Identity
GET /v1/users/me#
Get Identity
DashboardUserContextAuth#
200
OK
api_key#
organization#
workspace#
Playground
Test the endpoints live
import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral();
async function run() {
const result = await mistral.beta.users.getIdentity({
dashboardUserContextAuth: process.env["MISTRAL_DASHBOARD_USER_CONTEXT_AUTH"] ?? "",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral();
async function run() {
const result = await mistral.beta.users.getIdentity({
dashboardUserContextAuth: process.env["MISTRAL_DASHBOARD_USER_CONTEXT_AUTH"] ?? "",
});
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.users.get_identity()
# 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.users.get_identity()
# Handle response
print(res)
curl https://api.mistral.ai/v1/users/me \
-X GET \
-H 'DashboardUserContextAuth: YOUR_DASHBOARDUSERCONTEXTAUTH_HERE' \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/users/me \
-X GET \
-H 'DashboardUserContextAuth: YOUR_DASHBOARDUSERCONTEXTAUTH_HERE' \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'200
{
"email": null,
"first_name": null,
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"last_name": null
}{
"email": null,
"first_name": null,
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"last_name": null
}List Organizations
GET /v1/users/me/organizations#
List every organization the authenticated user is a member of.
Identity-only: the caller need not have selected an organization, so this reads only the user and never scopes by the active org.
DashboardUserContextAuth#
200
OK
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/users/me/organizations \
-X GET \
-H 'DashboardUserContextAuth: YOUR_DASHBOARDUSERCONTEXTAUTH_HERE' \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/users/me/organizations \
-X GET \
-H 'DashboardUserContextAuth: YOUR_DASHBOARDUSERCONTEXTAUTH_HERE' \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral();
async function run() {
const result = await mistral.beta.users.listOrganizations({
dashboardUserContextAuth: process.env["MISTRAL_DASHBOARD_USER_CONTEXT_AUTH"] ?? "",
}, {});
for await (const page of result) {
console.log(page);
}
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral();
async function run() {
const result = await mistral.beta.users.listOrganizations({
dashboardUserContextAuth: process.env["MISTRAL_DASHBOARD_USER_CONTEXT_AUTH"] ?? "",
}, {});
for await (const page of result) {
console.log(page);
}
}
run();200
{
"organizations": [
{
"id": "1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d",
"name": "Acme Corp"
}
]
}{
"organizations": [
{
"id": "1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d",
"name": "Acme Corp"
}
]
}List Workspaces
GET /v1/users/me/workspaces#
List every workspace the authenticated user is a member of, across all their organizations, each tagged with the organization it belongs to.
DashboardUserContextAuth#
200
OK
The workspaces the authenticated user is a member of, each tagged with the organization it belongs to.
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/users/me/workspaces \
-X GET \
-H 'DashboardUserContextAuth: YOUR_DASHBOARDUSERCONTEXTAUTH_HERE' \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/users/me/workspaces \
-X GET \
-H 'DashboardUserContextAuth: YOUR_DASHBOARDUSERCONTEXTAUTH_HERE' \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral();
async function run() {
const result = await mistral.beta.users.listWorkspaces({
dashboardUserContextAuth: process.env["MISTRAL_DASHBOARD_USER_CONTEXT_AUTH"] ?? "",
}, {
organizationId: "1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d",
});
for await (const page of result) {
console.log(page);
}
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral();
async function run() {
const result = await mistral.beta.users.listWorkspaces({
dashboardUserContextAuth: process.env["MISTRAL_DASHBOARD_USER_CONTEXT_AUTH"] ?? "",
}, {
organizationId: "1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d",
});
for await (const page of result) {
console.log(page);
}
}
run();200
{
"workspaces": [
{
"id": "7f8e9d0c-1b2a-4c3d-8e9f-0a1b2c3d4e5f",
"name": "production",
"organization_id": "1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d"
}
]
}{
"workspaces": [
{
"id": "7f8e9d0c-1b2a-4c3d-8e9f-0a1b2c3d4e5f",
"name": "production",
"organization_id": "1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d"
}
]
}