Prompt

Le composant <Prompt> transforme un ensemble d’instructions réutilisables en une carte que les lecteurs peuvent copier ou ouvrir dans un outil d’IA compatible. Les actions de copie et d’ouverture utilisent exactement le contenu rédigé que voient les humains entre les balises.

Utilisation de base

Chaque Prompt inclut une action Copier. La version la plus simple ne nécessite donc aucune prop :

Expliquez le fonctionnement de la rotation des clés API à un développeur qui utilise notre API REST pour la première fois.

<Prompt>

Explain how API key rotation works for a developer using our REST API for the first time.

</Prompt>

Titre et description

Utilisez title pour nommer la tâche. La prop description, compatible avec Mintlify, remplace l’aperçu visible par un résumé plus court, tandis que le contenu rédigé que voient les humains entre les balises reste le prompt complet utilisé par les actions Copier et d’ouverture.

Rédigez une note de version pour le nouveau point de terminaison de rotation des clés API.

- Adressez-vous aux développeurs backend.
- Commencez par l’avantage pour l’utilisateur.
- Incluez un exemple de requête.

<Prompt
  title="Draft a release note"
  description="Write a concise release note for a developer audience."
  actions={["copy", "claude"]}
>
Write a release note for the new API key rotation endpoint.

- Address backend developers.
- Lead with the user benefit.
- Include one request example.

</Prompt>

L’action explicite "copy" est acceptée à des fins de compatibilité, mais Copier est toujours présent et n’a jamais besoin d’être indiqué.

Actions d’ouverture

Ajoutez claude, cursor, chatgpt, perplexity ou gemini pour permettre aux lecteurs d’ouvrir le prompt dans ces outils, chacun avec son icône de marque. La première action d’ouverture valide apparaît à côté de Copier ; les actions supplémentaires figurent dans le menu Plus.

Comparez les flux d’authentification par jeton de session et par clé API dans ce dépôt. Énumérez leurs compromis de sécurité et recommandez le flux que chaque type de client doit utiliser.

<Prompt
  title="Compare authentication flows"
  actions={["claude", "cursor", "chatgpt", "perplexity", "gemini"]}
>
Compare the session-token and API-key authentication flows in this repository.
List their security tradeoffs and recommend which flow each client type should use.

</Prompt>

Actions avec URL personnalisée

Les actions personnalisées acceptent un label, une url HTTPS ou HTTP et une icône facultative. Placez {prompt} dans un segment de chemin, une valeur de requête ou un fragment pour définir l’emplacement du prompt encodé dans l’URL. Si vous omettez cet espace réservé, Jamdesk ajoute un paramètre de requête prompt.

Comparez ce plan de migration au contrat actuel de l’API publique. Identifiez les changements incompatibles, les étapes de restauration manquantes et les tests nécessaires avant la mise en production.

<Prompt
  title="Research this migration"
  actions={[
    {
      label: "Search the web",
      url: "https://www.google.com/search?q={prompt}",
      icon: "magnifying-glass",
    },
    "claude",
  ]}
>
Compare this migration plan with the current public API contract. Identify
breaking changes, missing rollback steps, and tests needed before release.

</Prompt>

Les URL des actions personnalisées doivent être des URL http: ou https: sans identifiants. Jamdesk rejette les autres protocoles, les espaces réservés dans les origines ou les clés de requête, ainsi que les URL d’action finales de plus de 8 000 caractères. Copier reste disponible lorsqu’une action d’ouverture est rejetée.

Icône personnalisée

Définissez icon sur un nom Font Awesome, une URL ou un chemin d’image, ou un SVG intégré. Utilisez iconType pour sélectionner le style d’un nom Font Awesome sans préfixe.

Élaborez le plan d’un tutoriel pratique qui mène un nouvel utilisateur de l’installation à une requête API réussie en moins de dix minutes.

<Prompt title="Plan a tutorial" icon="pen-nib" iconType="duotone">

  Outline a hands-on tutorial that gets a new user from installation to a
  successful API request in under ten minutes.

</Prompt>

Consultez Icônes pour connaître les noms et les styles disponibles.

Affichages compacts

L’aperçu affiche jusqu’à trois lignes et défile lorsque le prompt est plus long ; le contrôle Agrandir ouvre le prompt complet. Définissez singleLine pour limiter l’aperçu à une seule ligne. Dans tous les cas, le prompt complet visible par les humains est toujours copié ou envoyé par une action d’ouverture.

Résumez l’API publique en cinq points :

- Authentification et durée de vie des jetons.
- Conventions de pagination.
- Limites de débit et stratégie de nouvelle tentative.
- Format des erreurs et codes courants.
- Versionnage et politique de dépréciation.

Utilisez hidePrompt avec un titre lorsque le libellé suffit à donner le contexte aux lecteurs :

Créez une liste de contrôle pour migrer de l’API v1 vers la v2. Incluez les prérequis, les modifications du code, les étapes de validation, les critères de restauration et l’approbation du responsable.

<Prompt title="Summarize the API">

  Summarize the public API in five bullets:

  - Authentication and token lifetimes.
  - Pagination conventions.
  - Rate limits and retry guidance.
  - Error format and common codes.
  - Versioning and deprecation policy.

</Prompt>

<Prompt title="Generate a migration checklist" hidePrompt actions={["claude"]}>

  Create a migration checklist for moving from API v1 to v2. Include
  prerequisites, code changes, validation steps, and rollback criteria.

</Prompt>

hidePrompt masque l’aperçu uniquement lorsque title est présent. Sans titre, Jamdesk maintient le prompt visible pour que la carte reste compréhensible.

Props

Et ensuite ?