POST
/
v1
/
experimental
/
templatize_prompt

Las APIs de herramientas de prompts están en una vista previa de investigación cerrada. Solicita unirte a la vista previa de investigación cerrada.

Antes de comenzar

Las herramientas de prompts son un conjunto de APIs para generar y mejorar prompts. A diferencia de nuestras otras APIs, esta es una API experimental: necesitarás solicitar acceso y no tiene el mismo nivel de compromiso de soporte a largo plazo que otras APIs.

Estas APIs son similares a las disponibles en Anthropic Workbench, y están destinadas para su uso por otras plataformas y entornos de ingeniería de prompts.

Comenzando con el mejorador de prompts

Para usar la API de generación de prompts, necesitarás:

  1. Haberte unido a la vista previa de investigación cerrada para las APIs de herramientas de prompts
  2. Usar la API directamente, en lugar del SDK
  3. Agregar el encabezado beta prompt-tools-2025-04-02

Esta API no está disponible en el SDK

Crear plantillas de un 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
messages
object[]
required

The prompt to templatize, 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

Example of a simple text prompt:

[
  {
    "role": "user", 
    "content": [
      {
        "type": "text",
        "text": "Translate hello to German"
      }
    ]
  }
]

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

system
string | null

The existing system prompt to templatize.

{
  "system": "You are a professional English to German translator",
  [...]
}

Note that this differs from the Messages API; it is strictly a string.

Response

200 - application/json
messages
object[]
required

The templatized prompt with variable placeholders.

The response includes the input messages with specific values replaced by variable placeholders. These messages maintain the original message structure but contain uppercase variable names in place of concrete values.

For example, an input message content like "Translate hello to German" would be transformed to "Translate {{WORD_TO_TRANSLATE}} to {{TARGET_LANGUAGE}}".

{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "Translate {{WORD_TO_TRANSLATE}} to {{TARGET_LANGUAGE}}"
        }
      ]
    }
  ]
}
system
string
required

The input system prompt with variables identified and replaced.

If no system prompt was provided in the original request, this field will be an empty string.

usage
object
required

Usage information

variable_values
object
required

A mapping of template variable names to their original values, as extracted from the input prompt during templatization. Each key represents a variable name identified in the templatized prompt, and each value contains the corresponding content from the original prompt that was replaced by that variable.

Example:

"variable_values": {
  "WORD_TO_TRANSLATE": "hello",
  "TARGET_LANGUAGE": "German"
}

In this example response, the original prompt – Translate hello to German – was templatized to Translate WORD_TO_TRANSLATE to TARGET_LANGUAGE, with the variable values extracted as shown.