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

Clés API Admin Bêta

(beta) API Admin - gérer les clés API. Nécessite une clé API admin.

Obtenir les clés API

GET /v1/admin/api-keys#

Lister les clés API de l'Organisation.

200

OK

keys#
*array<APIKeyExtendedOUT>

Clés API pour l'Organisation.

Playground

Testez les endpoints en direct

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

200

{
  "keys": [
    {
      "actions": {},
      "can_delete": null,
      "created_at": null,
      "created_by": null,
      "expiration_date": null,
      "hidden_key": "HQSx...Ug6Y",
      "key": null,
      "key_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
      "last_used": null,
      "name": null,
      "product": "API",
      "workspace_id": null,
      "workspace_name": null
    }
  ]
}

Créer une clé API

POST /v1/admin/api-keys#

Créer une clé API d'Espace de travail.

200

OK

actions#
*APIKeyActions

Disponibilité par action pour une clé API, indexée par nom d'action.

Il s'agit de la forme générique et réutilisable pour indiquer ce qu'un utilisateur peut faire avec une ressource sur les points de terminaison get/list : chaque action est associée à une valeur qui est soit disponible, soit indisponible avec un code de raison optionnel. Ajoutez des champs ici au fur et à mesure que de nouvelles actions sont exposées.

Chaque action est optionnelle : les champs sont par défaut à None (l'action est absente), et une action absente signifie "indisponible, sans raison spécifiée". Une action n'est disponible que lorsqu'un producteur la définit explicitement à ActionAvailable. Cela maintient les permissions en opt-in plutôt qu'en opt-out, de sorte qu'oublier de renseigner une action ne peut jamais l'exposer accidentellement.

created_at#
*date-time|null

Date de création de la clé API.

expiration_date#
*date|null

Date d'expiration de la clé API.

hidden_key#
*string

Valeur masquée de la clé API pour l'affichage.

key#
*string|null

Valeur en texte clair de la clé API. Uniquement renvoyée au moment de la création.

key_id#
*string

ID de la clé API.

name#
*string|null

Nom de la clé API.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/api-keys \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "user_id": "9c0ab39f-0cd0-46cd-bd30-8bf2d50be5ce",
  "workspace_uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}'

200

{
  "actions": {},
  "created_at": null,
  "expiration_date": null,
  "hidden_key": "HQSx...Ug6Y",
  "key": null,
  "key_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "name": null
}

Supprimer une clé API

DELETE /v1/admin/api-keys/{key_id}#

Supprimer une clé API.

200

OK

detail#
*string

Message de résultat de suppression de la clé API.

Playground

Testez les endpoints en direct

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

200

{
  "detail": "API key deleted successfully"
}