Generate a prompt
Generate a well-written prompt
The prompt tools APIs are in a closed research preview. Request to join the closed research preview.
Before you begin
The prompt tools are a set of APIs to generate and improve prompts. Unlike our other APIs, this is an experimental API: you’ll need to request access, and it doesn’t have the same level of commitment to long-term support as other APIs.
These APIs are similar to what’s available in the Anthropic Workbench, and are intented for use by other prompt engineering platforms and playgrounds.
Getting started with the prompt generator
To use the prompt generation API, you’ll need to:
- Have joined the closed research preview for the prompt tools APIs
- Use the API directly, rather than the SDK
- Add the beta header
prompt-tools-2025-04-02
This API is not available in the SDK
Generate a prompt
Headers
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.
Body
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"}
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"
1 - 256Response
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>"
}
]
}
]
}
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 information
Was this page helpful?