Prompt

O componente <Prompt> transforma um conjunto reutilizável de instruções em um cartão que os leitores podem copiar ou abrir em uma ferramenta de IA compatível. As ações de cópia e abertura usam exatamente o conteúdo visível escrito entre as tags.

Uso básico

Todo Prompt inclui uma ação Copy, portanto a versão mais simples não precisa de propriedades:

Explique como funciona a rotação de chaves de API para um desenvolvedor que usa nossa API REST pela primeira vez.

<Prompt>

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

</Prompt>

Título e descrição

Use title para identificar a tarefa. A propriedade description, compatível com Mintlify, substitui a visualização prévia visível por um resumo mais curto, enquanto o conteúdo visível escrito entre as tags continua sendo o prompt completo usado pelas ações Copy e de abertura.

Escreva uma nota de lançamento para o novo endpoint de rotação de chaves de API.

- Dirija-se a desenvolvedores de back-end.
- Comece pelo benefício para o usuário.
- Inclua um exemplo de request.

<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>

A ação explícita "copy" é aceita por compatibilidade, mas Copy está sempre presente e nunca precisa ser listada.

Ações de abertura

Adicione claude, cursor, chatgpt, perplexity ou gemini para permitir que os leitores abram o prompt nessas ferramentas, cada uma com seu ícone de marca. A primeira ação de abertura válida aparece ao lado de Copy; as ações adicionais aparecem no menu More.

Compare os fluxos de autenticação por token de sessão e por chave de API neste repositório. Liste as vantagens e desvantagens de segurança e recomende qual fluxo cada tipo de cliente deve usar.

<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>

Ações com URL personalizada

As ações personalizadas recebem um label, uma url HTTP ou HTTPS e um ícone opcional. Insira {prompt} em um segmento de caminho, valor de consulta ou fragmento para controlar onde o prompt codificado na URL será inserido. Se você omitir o marcador, o Jamdesk adicionará um parâmetro de consulta prompt.

Compare este plano de migração com o contrato atual da API pública. Identifique alterações incompatíveis, etapas de rollback ausentes e os testes necessários antes do lançamento.

<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>

As URLs de ações personalizadas devem usar URLs http: ou https: sem credenciais. O Jamdesk rejeita outros esquemas, marcadores em origens ou chaves de consulta e URLs de ação finais com mais de 8.000 caracteres. Copy continua disponível quando uma ação de abertura é rejeitada.

Ícone personalizado

Defina icon como um nome do Font Awesome, uma URL ou caminho de imagem ou um SVG embutido. Use iconType para selecionar o estilo de um nome do Font Awesome sem prefixo.

Elabore um tutorial prático que leve um novo usuário da instalação até uma request de API bem-sucedida em menos de dez minutos.

<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>

Consulte Icons para ver os nomes e estilos disponíveis.

Exibições compactas

A visualização prévia mostra até três linhas e permite rolagem quando o prompt é mais longo; o controle Expand abre o prompt completo. Defina singleLine para limitar a visualização prévia a uma única linha. Em ambos os casos, o prompt completo visível continua sendo copiado ou enviado por uma ação de abertura.

Resuma a API pública em cinco tópicos:

- Autenticação e durações dos tokens.
- Convenções de paginação.
- Limites de taxa e orientações para novas tentativas.
- Formato dos erros e códigos comuns.
- Política de versionamento e descontinuação.

Use hidePrompt com um título quando apenas o rótulo fornecer contexto suficiente aos leitores:

Crie uma checklist de migração para passar da API v1 para a v2. Inclua pré-requisitos, alterações de código, etapas de validação, critérios de rollback e aprovação do responsável.

<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 oculta a visualização prévia somente quando title está presente. Sem um título, o Jamdesk mantém o prompt visível para que o cartão continue compreensível.

Propriedades

O que vem a seguir?