Skip to main content
A API Prompts permite armazenar, versionar e gerenciar modelos de prompt de forma centralizada. Cada alteração no modelo cria uma versão imutável, oferecendo um histórico completo de alterações com a capacidade de reverter para qualquer versão anterior a qualquer momento. Os modelos oferecem suporte a marcadores {{variable}} que são renderizados no servidor quando você recupera um prompt, permitindo reutilizar o mesmo modelo em diferentes contextos.

Criar um prompt

Crie um prompt com um nome e um modelo. A primeira versão é criada automaticamente.

Recuperar um prompt com variáveis renderizadas

Passe variables como um parâmetro de consulta para renderizar o modelo com seus valores. Marcadores sem correspondência são mantidos como estão. Opcionalmente, passe version para recuperar (e renderizar) uma versão específica. Se omitido, a versão ativa será retornada.
A resposta sempre inclui active_template (activeTemplate no SDK TypeScript) — o texto bruto do modelo da versão solicitada, com os {{placeholders}} intactos. Ao passar variables, a resposta também inclui rendered_template (renderedTemplate) com o resultado substituído; ele não estará presente quando nenhuma variável for fornecida.

Listar prompts

Recupere uma lista paginada de todos os prompts. Use after para paginação baseada em cursor.

Atualizar metadados do prompt

Atualize o nome, a descrição ou os metadados de um prompt. Para alterar o modelo, crie uma nova versão. Observação: metadata substitui o objeto de metadados existente (não é mesclado). Para limpar uma descrição, passe null.

Criar uma nova versão

Cada alteração no modelo cria uma nova versão. A nova versão se torna automaticamente a versão ativa.

Ver histórico de versões

Liste todas as versões de um prompt para consultar seu histórico completo de alterações.

Recuperar uma versão específica

Busque uma única versão pelo seu número de versão.

Reverter para uma versão anterior

A reversão define uma versão anterior como a versão ativa. Todas as versões são preservadas — a reversão não exclui versões mais recentes, portanto você sempre pode avançar novamente.

Excluir um prompt

Excluir um prompt o remove permanentemente, juntamente com todas as suas versões.

Exemplo completo: fluxo de versionamento e reversão

Este exemplo demonstra o ciclo de vida completo — criar um prompt, iterar no modelo, revisar o histórico e reverter.

Detalhes de comportamento

Próximas etapas