POST
/
v1
/
experimental
/
improve_prompt

Die Prompt-Tools-APIs befinden sich in einer geschlossenen Forschungsvorschau. Beantragen Sie die Teilnahme an der geschlossenen Forschungsvorschau.

Bevor Sie beginnen

Die Prompt-Tools sind eine Reihe von APIs zum Generieren und Verbessern von Prompts. Im Gegensatz zu unseren anderen APIs handelt es sich hierbei um eine experimentelle API: Sie müssen Zugang beantragen, und sie bietet nicht das gleiche Maß an langfristiger Unterstützung wie andere APIs.

Diese APIs ähneln denen, die in der Anthropic Workbench verfügbar sind, und sind für die Nutzung durch andere Prompt-Engineering-Plattformen und Playgrounds gedacht.

Erste Schritte mit dem Prompt-Verbesserer

Um die Prompt-Generierungs-API zu nutzen, müssen Sie:

  1. Der geschlossenen Forschungsvorschau für die Prompt-Tools-APIs beigetreten sein
  2. Die API direkt nutzen, anstatt des SDKs
  3. Den Beta-Header prompt-tools-2025-04-02 hinzufügen

Diese API ist nicht im SDK verfügbar

Einen Prompt verbessern

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