POST
/
v1
/
experimental
/
generate_prompt

As APIs de ferramentas de prompt estão em uma prévia de pesquisa fechada. Solicite para participar da prévia de pesquisa fechada.

​
Antes de começar

As ferramentas de prompt são um conjunto de APIs para gerar e melhorar prompts. Diferentemente de nossas outras APIs, esta é uma API experimental: você precisará solicitar acesso, e ela não tem o mesmo nível de compromisso com suporte a longo prazo como outras APIs.

Essas APIs são similares ao que está disponível no Anthropic Workbench, e são destinadas para uso por outras plataformas de engenharia de prompt e playgrounds.

​
Começando com o gerador de prompt

Para usar a API de geração de prompt, você precisará:

  1. Ter se juntado à prévia de pesquisa fechada para as APIs de ferramentas de prompt
  2. Usar a API diretamente, em vez do SDK
  3. Adicionar o cabeçalho beta prompt-tools-2025-04-02

Esta API não está disponível no SDK

​
Gerar um prompt

Headers

​
anthropic-beta
string[]

Optional header to specify the beta version(s) you want to use.

To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.

​
x-api-key
string
required

Your unique API key for authentication.

This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the Console. Each key is scoped to a Workspace.

Body

application/json
​
task
string
required

Description of the prompt's purpose.

The task parameter tells Claude what the prompt should do or what kind of role or functionality you want to create. This helps guide the prompt generation process toward your intended use case.

Example:

{"task": "a chef for a meal prep planning service"}
​
target_model
string | null
default:

The model this prompt will be used for. This optional parameter helps us understand which models our prompt tools are being used with, but it doesn't currently affect functionality.

Example:

"claude-3-7-sonnet-20250219"
Required string length: 1 - 256

Response

200 - application/json
​
messages
object[]
required

The response contains a list of message objects in the same format used by the Messages API. Typically includes a user message with the complete generated prompt text, and may include an assistant message with a prefill to guide the model's initial response.

These messages can be used directly in a Messages API request to start a conversation with the generated prompt.

Example:

{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "You are a chef for a meal prep planning service..."
        }
      ]
    },
    {
      "role": "assistant",
      "content": [
        {
          "type": "text",
          "text": "<recipe_planning>"
        }
      ]
    }
  ]
}
​
system
string
default:
required

Currently, the system field is always returned as an empty string (""). In future iterations, this field may contain generated system prompts.

Directions similar to what would normally be included in a system prompt are included in messages when generating a prompt.

​
usage
object
required

Usage information

Was this page helpful?

API do Amazon BedrockMelhorar um prompt