---
title: "Get prompt template by name and environment"
method: GET
path: "/api/v2/projects/{project_id}/prompt-templates/name/{name}"
tags: ["Prompt Templates"]
---

# Get prompt template by name and environment

`GET /api/v2/projects/{project_id}/prompt-templates/name/{name}`

## Path parameters

- `project_id` string, required
- `name` string, required

## Query parameters

- `environment` string, nullable
- `format` string, nullable
- `flavor_name` string, nullable

## Response `200`

PlainPromptTemplate(prompt_template_id: uuid.UUID, prompt_template_version_id: uuid.UUID, prompt_template_name: str, version_name: Optional[str], version_description: Optional[str], metadata: server.api_routes.prompt_templates_api_v2.PromptTemplateMetadata, format_version: int, project_id: uuid.UUID, content: list[typing.Union[server.project_sessions.prompt_template_model.ChatMessageWithMediaSlot, server.project_sessions.prompt_template_model.ChatMessage, server.project_sessions.prompt_template_model.HistoryPlaceholder]], tool_schema: Optional[list[shared.common.NormalizedToolSchema]], output_schema: Optional[dict[str, Any]])

- object
  - `prompt_template_id` string, uuid, required
  - `prompt_template_version_id` string, uuid, required
  - `prompt_template_name` string, required
  - `version_name` string, nullable, required
  - `version_description` string, nullable, required
  - `metadata` PromptTemplateMetadata, required
    - `provider` string, nullable, required
    - `flavor` string, nullable, required
    - `model` string, nullable, required
    - `params` object, nullable, required
    - `provider_info` object, nullable, required
  - `format_version` integer, required
  - `project_id` string, uuid, required
  - `content` union[], required
    - union
      - ChatMessageWithMediaSlot
        - `role` string, required
        - `content` string, required
        - `media_slots` MediaSlot[]
          - `type` 'audio' | 'video' | 'image' | 'file', required
          - `placeholder_name` string, required
      - ChatMessage
        - `role` string, required
        - `content` string, required
      - HistoryPlaceholder
        - `kind` 'history'
  - `tool_schema` NormalizedToolSchema[], nullable, required
    - `name` string, required
    - `description` string, required
    - `parameters` object, required
  - `output_schema` object, nullable, required

---

[API](https://skmtc.net/freeplay/apis/freeplay-api.md) · [All operations](https://skmtc.net/freeplay/apis/freeplay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/freeplay/freeplay-api/revisions/69c553220183/schema)
