POST
/
v1
/
experimental
/
improve_prompt

提示詞工具 API 目前處於封閉研究預覽階段。申請加入封閉研究預覽

開始之前

提示詞工具是一組用於生成和改進提示詞的 API。與我們的其他 API 不同,這是一個實驗性 API:您需要申請訪問權限,並且它不像其他 API 那樣對長期支持有相同程度的承諾。

這些 API 與 Anthropic Workbench 中提供的功能類似,旨在供其他提示詞工程平台和實驗環境使用。

開始使用提示詞改進工具

要使用提示詞生成 API,您需要:

  1. 已加入提示詞工具 API 的封閉研究預覽
  2. 直接使用 API,而不是 SDK
  3. 添加測試版標頭 prompt-tools-2025-04-02

此 API 在 SDK 中不可用

改進提示詞

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
messages
object[]
required

The prompt to improve, structured as a list of message objects.

Each message in the messages array must:

  • Contain only text-only content blocks
  • Not include tool calls, images, or prompt caching blocks

As a simple text prompt:

[
  {
    "role": "user", 
    "content": [
      {
        "type": "text",
        "text": "Concise recipe for {{food}}"
      }
    ]
  }
]

With example interactions to guide improvement:

[
  {
    "role": "user", 
    "content": [
      {
        "type": "text",
        "text": "Concise for {{food}}.\n\nexample\mandu: Put the mandu in the air fryer at 380F for 7 minutes."
      }
    ]
  }
]

Note that only contiguous user messages with text content are allowed. Assistant prefill is permitted, but other content types will cause validation errors.

feedback
string | null

Feedback for improving the prompt.

Use this parameter to share specific guidance on what aspects of the prompt should be enhanced or modified.

Example:

{
  "messages": [...],
  "feedback": "Make the recipes shorter"
}

When not set, the API will improve the prompt using general prompt engineering best practices.

system
string | null

The existing system prompt to incorporate, if any.

{
  "system": "You are a professional meal prep chef",
  [...]
}

Note that while system prompts typically appear as separate parameters in standard API calls, in the improve_prompt response, the system content will be incorporated directly into the returned user message.

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

Contains the result of the prompt improvement process in a list of message objects.

Includes a user-role message with the improved prompt text and may optionally include an assistant-role message with a prefill. These messages follow the standard Messages API format and can be used directly in subsequent API calls.

system
string
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 improving a prompt.

usage
object
required

Usage information