La spec OpenAPI
Home
Tree BG 1
Tree
Tree
TreeLeaves
TreeLeaves
Cat IdleGrassGrassRockRock

Endpoints Beta Admin Workspaces

Gérez les espaces de travail et les appartenances aux espaces de travail.

Obtenir les espaces de travail

GET /api/admin/workspaces

Liste les espaces de travail de l'organisation.

200

OK

items
*array<WorkspaceOUT>

Espaces de travail sur cette page.

object
"list"

Valeur par défaut : "list"

Type d'objet API paginé.

page
*integer

Numéro de page renvoyé.

page_size
*integer

Nombre maximal de résultats par page.

total
*integer

Nombre total d'espaces de travail correspondant à la requête.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/api/admin/workspaces \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "items": [
    {
      "description": null,
      "icon": null,
      "is_default": false,
      "name": "ipsum eiusmod",
      "uuid": "consequat do"
    }
  ],
  "page": 87,
  "page_size": 14,
  "total": 56
}

Créer un espace de travail

POST /api/admin/workspaces

Crée un espace de travail.

200

OK

description
*string|null

Description de l'espace de travail.

icon
*string|null

Icône de l'espace de travail.

is_default
*boolean

Indique s'il s'agit de l'espace de travail par défaut de l'organisation.

members_count
integer|null

Nombre de membres dans l'espace de travail.

name
*string

Nom de l'espace de travail.

raw_role
*"A"|"M"|"d7ea77c5-9260-41d0-ab26-52b5add3ee56"|"48436751-ee56-44bd-8a2d-712233977821"|"375cd0db-3bbe-4b79-80f3-954ccf04f3d1"|"578584f1-4319-4c88-9948-38a5184483b6"|"d79b3027-4eb2-4521-8722-825acfee7d8b"|"252a0825-40b9-4b98-be80-7658956f13e9"|"b23cd6e0-91cd-4a8a-9869-b30366bf3966"|"731eb2be-a74f-4070-b797-35bf7009e553"|"ff86d432-7f27-47f8-b02f-b5c102ef6a55"|"0d48f530-095c-43fe-8aea-6673bcacabe6"|"c955f4e1-9477-43f0-8349-6fbc629fccc9"|"7bde5959-d676-47d2-b779-35b64323d278"

Rôle unique obsolète pour l'espace de travail. Utilisez « raw_roles » à la place.

raw_roles
*array<"A"|"M"|"d7ea77c5-9260-41d0-ab26-52b5add3ee56"|"48436751-ee56-44bd-8a2d-712233977821"|"375cd0db-3bbe-4b79-80f3-954ccf04f3d1"|"578584f1-4319-4c88-9948-38a5184483b6"|"d79b3027-4eb2-4521-8722-825acfee7d8b"|"252a0825-40b9-4b98-be80-7658956f13e9"|"b23cd6e0-91cd-4a8a-9869-b30366bf3966"|"731eb2be-a74f-4070-b797-35bf7009e553"|"ff86d432-7f27-47f8-b02f-b5c102ef6a55"|"0d48f530-095c-43fe-8aea-6673bcacabe6"|"c955f4e1-9477-43f0-8349-6fbc629fccc9"|"7bde5959-d676-47d2-b779-35b64323d278">

Rôles attribués pour l'espace de travail.

spend_limit
WorkspaceSpendLimitOUT|null

Limite de dépenses de l'espace de travail.

uuid
*string

Identifiant de l'espace de travail.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/api/admin/workspaces \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "admin_user_id": "ipsum eiusmod",
  "name": "consequat do"
}'

200

{
  "description": null,
  "icon": null,
  "is_default": false,
  "name": "ipsum eiusmod",
  "raw_role": "A",
  "raw_roles": [
    "A"
  ],
  "uuid": "consequat do"
}

Supprimer des espaces de travail

DELETE /api/admin/workspaces/{workspace_uuid}

Archive un espace de travail.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/api/admin/workspaces/{workspace_uuid} \
 -X DELETE \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

Mettre à jour des espaces de travail

PATCH /api/admin/workspaces/{workspace_uuid}

Met à jour un espace de travail.

200

OK

description
*string|null

Description de l'espace de travail.

icon
*string|null

Icône de l'espace de travail.

is_default
*boolean

Indique s'il s'agit de l'espace de travail par défaut de l'organisation.

members_count
integer|null

Nombre de membres dans l'espace de travail.

name
*string

Nom de l’espace de travail.

spend_limit
WorkspaceSpendLimitOUT|null

Limite de dépenses de l’espace de travail.

uuid
*string

ID de l’espace de travail.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/api/admin/workspaces/{workspace_uuid} \
 -X PATCH \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{}'

200

{
  "description": null,
  "icon": null,
  "is_default": false,
  "name": "ipsum eiusmod",
  "uuid": "consequat do"
}

Ajouter des membres à un espace de travail

POST /api/admin/workspaces/{workspace_uuid}/add-users

Ajouter des membres à un espace de travail.

200

OK

added_members_count
*integer

Nombre d’utilisateurs ajoutés à l’espace de travail.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/api/admin/workspaces/{workspace_uuid}/add-users \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{}'

200

{
  "added_members_count": 87
}

Ajouter ou mettre à jour des membres dans un espace de travail

PATCH /api/admin/workspaces/{workspace_uuid}/users

Ajouter ou mettre à jour des membres dans un espace de travail.

200

OK

added_members_count
*integer

Nombre d’utilisateurs ajoutés à l’espace de travail.

updated_members_count
*integer

Nombre de membres de l’espace de travail mis à jour.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/api/admin/workspaces/{workspace_uuid}/users \
 -X PATCH \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{}'

200

{
  "added_members_count": 87,
  "updated_members_count": 14
}

Retirer des membres d’un espace de travail

DELETE /api/admin/workspaces/{workspace_uuid}/remove-users

Retirer des membres d’un espace de travail.

200

OK

deleted_members_count
*integer

Nombre de membres de l’espace de travail retirés.

not_deleted_members
array<string>|null

Utilisateurs qui n’ont pas pu être retirés.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/api/admin/workspaces/{workspace_uuid}/remove-users \
 -X DELETE \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "members": [
    {
      "user_uuid": "ipsum eiusmod"
    }
  ]
}'

200

{
  "deleted_members_count": 87
}