Aperçu de l'API

Bienvenue dans la documentation de l'API Minds. Notre API vous permet de créer et gérer des AI minds de manière programmatique, d'uploader des connaissances et d'interagir avec eux.

Démarrage

L'API Minds est organisée autour des principes REST. Notre API possède des URLs prévisibles orientées ressources, accepte des corps de requête encodés en JSON, renvoie des réponses encodées en JSON, et utilise les codes de réponse HTTP standards, l'authentification et les verbes HTTP classiques.

URL de base

Production : https://getminds.ai/api/v1 ou https://api.getminds.ai/v1

Développement local : http://localhost:3000/api/v1

Les deux URLs de base en production sont totalement équivalentes. Le sous-domaine api.getminds.ai est recommandé pour des URLs d'intégration plus propres.

Authentification

Tous les endpoints de l'API nécessitent une authentification via une API key. Vous pouvez générer et gérer vos API keys via Settings → API Keys.

Incluez votre API key dans l'en-tête Authorization :

Authorization: Bearer minds_your_api_key_here

Spécification OpenAPI

Une spécification OpenAPI 3.1.0 lisible par machine est publiée sur /_openapi.json. Utilisez la spécification pour générer des clients typés (TypeScript, Python, etc.) ou pour l'injecter dans un LLM afin d'obtenir du code d'intégration en une fois. Voir OpenAPI pour des exemples.

Content Type

Toutes les requêtes qui envoient des données doivent inclure l'en-tête Content-Type :

Content-Type: application/json

Pour les uploads de fichiers, utilisez :

Content-Type: multipart/form-data

Endpoints disponibles

Minds

Créez et gérez des AI minds (agents) avec des configurations personnalisées.

• GET /api/v1/minds - Lister tous les Minds
• GET /api/v1/minds/{mindId} - Obtenir les détails d'un Mind
• POST /api/v1/minds - Créer un nouveau Mind
• PUT /api/v1/minds/{mindId} - Mettre à jour un Mind
• DELETE /api/v1/minds/{mindId} - Supprimer un Mind
• POST /api/v1/minds/{mindId}/regenerate-prompt - Régénérer le system prompt à partir des connaissances

Knowledge

Gérez les connaissances de vos minds.

• GET /api/v1/minds/{mindId}/knowledge - Lister les éléments de connaissance
• POST /api/v1/minds/{mindId}/knowledge - Ajouter des connaissances (liens, fichiers ou recherche par mots-clés)
• PUT /api/v1/minds/{mindId}/knowledge/{itemId} - Mettre à jour un élément de connaissance
• DELETE /api/v1/minds/{mindId}/knowledge/{itemId} - Supprimer un élément de connaissance
• POST /api/v1/minds/{mindId}/knowledge/enrich - Enrichir via recherche par mots-clés (alias pratique)
• GET /api/v1/minds/{mindId}/knowledge/patterns - Obtenir les patterns de connaissance par framework

Chat

Interagissez avec vos minds via des chat completions.

• POST /api/v1/minds/{mindId}/completion - Envoyer des messages et recevoir des réponses

Studies

Créez et gérez des AI studies pour interroger des audiencees de minds.

• GET /api/v1/studies - Lister tous les studies
• POST /api/v1/studies - Créer un nouveau study
• GET /api/v1/studies/{studyId} - Obtenir les détails d'un study avec l'historique des messages
• POST /api/v1/studies/{studyId}/ask - Poser une question à tous les minds du study (flux SSE)
• POST /api/v1/studies/{studyId}/export - Exporter les résultats du study sous forme de rapport
• GET /api/v1/studies/{studyId}/export-status - Vérifier le statut du job d'export
• GET /api/v1/studies/{studyId}/export-download - Télécharger le PDF exporté

User

Endpoints liés à l'utilisateur.

• GET /api/v1/auth/me - Obtenir l'utilisateur actuellement authentifié
• GET /api/v1/user/shareable-sparks - Lister les minds disponibles au partage

API Keys

Gérez vos API keys pour l'authentification.

• GET /api/v1/api-keys - Lister vos API keys
• POST /api/v1/api-keys - Créer une nouvelle API key
• DELETE /api/v1/api-keys/{keyId} - Supprimer une API key

Exemple rapide

Voici un exemple rapide de création d'un mind puis d'une conversation avec lui :

# 1. Créer un mind (mode keywords)
curl -X POST "https://getminds.ai/api/v1/minds" \
  -H "Authorization: Bearer minds_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Marketing Expert",
    "description": "Expert in digital marketing strategies",
    "mode": "keywords",
    "type": "expert",
    "discipline": "Marketing",
    "keywords": ["SEO", "content marketing", "social media", "analytics"]
  }'

# Response: { "data": { "id": "mind-id", ... }, "processing": { "queued": true, ... } }

# 2. Créer un mind à partir d'un profil social (mode clone)
curl -X POST "https://getminds.ai/api/v1/minds" \
  -H "Authorization: Bearer minds_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Influencer Clone",
    "description": "AI trained on influencer social presence",
    "mode": "clone",
    "type": "creative",
    "discipline": "Social Media Marketing",
    "personaContext": "https://twitter.com/username"
  }'

# 3. Discuter avec le mind
curl -X POST "https://getminds.ai/api/v1/minds/mind-id/completion" \
  -H "Authorization: Bearer minds_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "role": "user",
        "content": "What are the top social media trends for 2025?"
      }
    ]
  }'

Étapes suivantes

• Découvrez l'Authentification
• Explorez les endpoints Minds
• Lisez la gestion des connaissances
• Comprenez les Chat completions
• Créez des Studies pour des enquêtes multi-minds
• Consultez Latency & Performance
• Connectez-vous via l'intégration MCP
• Consultez Errors & Limits

Limites selon l'offre

L'accès à l'API et à MCP est disponible avec les offres payantes prises en charge. Gérez les réponses structurées plan_limited et 429 au lieu de coder les limites en dur dans votre intégration. L'offre Individual apparaît comme "premium" dans les payloads API.

Les valeurs publiques par défaut ci-dessous sont générées à partir du même contrat de limites et d'accès aux fonctionnalités que le produit. Les ajustements propres au compte ou au contrat Enterprise affichés dans le produit prévalent.

Voir les offres

Besoin d'aide ?

Si vous avez des questions ou besoin d'aide avec l'API :

• Consultez notre Guide
• Contactez-nous via le formulaire de feedback
• Rejoignez nos discussions communautaires