Publish Prompt Template

POST /rest/prompt-templates

Publish Prompt Template

cURL

curl --request POST \
  --url https://api.promptlayer.com/rest/prompt-templates \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "prompt_template": {
    "prompt_name": "<string>",
    "tags": [],
    "folder_id": 1,
    "workspace_id": 123
  },
  "prompt_version": {
    "prompt_template": {
      "content": [
        {
          "text": "<string>",
          "type": "text",
          "id": "<string>",
          "annotations": [
            {
              "type": "<string>",
              "title": "<string>",
              "url": "<string>",
              "start_index": 123,
              "end_index": 123,
              "cited_text": "<string>",
              "encrypted_index": "<string>"
            }
          ],
          "thought_signature": "<string>"
        }
      ],
      "input_variables": [],
      "template_format": "f-string",
      "type": "completion"
    },
    "commit_message": "<string>",
    "metadata": {
      "model": {
        "provider": "<string>",
        "name": "<string>",
        "model_config_display_name": "<string>",
        "base_model": "<string>",
        "parameters": {},
        "display_params": {},
        "api_type": "<string>"
      }
    }
  },
  "release_labels": [
    "<string>"
  ],
  "external_ids": [
    {
      "source": "<string>",
      "external_id": "<string>"
    }
  ]
}
'

200

{
  "id": 123,
  "prompt_name": "<string>",
  "prompt_version_id": 123,
  "version_number": 123,
  "tags": [
    "<string>"
  ],
  "prompt_template": {
    "content": [
      {
        "text": "<string>",
        "type": "text",
        "id": "<string>",
        "annotations": [
          {
            "type": "<string>",
            "title": "<string>",
            "url": "<string>",
            "start_index": 123,
            "end_index": 123,
            "cited_text": "<string>",
            "encrypted_index": "<string>"
          }
        ],
        "thought_signature": "<string>"
      }
    ],
    "input_variables": [],
    "template_format": "f-string",
    "type": "completion"
  },
  "external_ids": [
    {
      "source": "<string>",
      "external_id": "<string>"
    }
  ],
  "release_labels": [
    "<string>"
  ],
  "metadata": {
    "model": {
      "provider": "<string>",
      "name": "<string>",
      "model_config_display_name": "<string>",
      "base_model": "<string>",
      "parameters": {},
      "display_params": {},
      "api_type": "<string>"
    }
  },
  "commit_message": "<string>"
}

Publish Prompt Template allows you to programmatically create a new version of a prompt template and make it available for use in the application.

Authorizations

X-API-KEY · string · header · required

Body

application/json

prompt_template · BasePromptTemplate · object · required

Template metadata, including prompt name, tags, folder, and workspace fields.

Show child attributes

prompt_version · PromptVersion · object · required

Version content and configuration.

Show child attributes

release_labels · string[] | null

Release labels to create or move to the newly created version.

external_ids · ExternalId · object[] | null

Identifiers from other systems.

Show child attributes

Response

200

application/json

Successful Response

id · integer · required

The ID of the prompt template.

prompt_name · string · required

The name of the prompt template.

prompt_version_id · integer · required

The ID of the created prompt version.

version_number · integer · required

The version number of the prompt template.

tags · string[] · required

prompt_template · Completion Template · object · required

Completion Template

Chat Template

Show child attributes

external_ids · ExternalId · object[] · required

External ID mappings attached to the prompt template.

Show child attributes

release_labels · string[] | null

metadata · Metadata · object

Metadata associated with the prompt blueprint. Supports additional custom fields beyond the model field.

Show child attributes

commit_message · string | null