---
title: "Get prompt version by ID"
method: GET
path: "/v1/prompt_versions/{prompt_version_id}"
tags: ["prompts"]
---

# Get prompt version by ID

`GET /v1/prompt_versions/{prompt_version_id}`

Retrieve a specific prompt version using its unique identifier. A prompt version contains the actual template and configuration.

## Path parameters

- `prompt_version_id` string, required — The ID of the prompt version.

## Response `200`

The requested prompt version

- GetPromptResponseBody
  - `data` PromptVersion, required
    - `description` string, nullable
    - `model_provider` 'OPENAI' | 'AZURE_OPENAI' | 'ANTHROPIC' | 'GOOGLE' | 'DEEPSEEK' | 'XAI' | 'OLLAMA' | 'AWS' | 'CEREBRAS' | 'FIREWORKS' | 'GROQ' | 'MOONSHOT' | 'PERPLEXITY' | 'TOGETHER', required
    - `model_name` string, required
    - `template` union, required
      - PromptChatTemplate
        - `type` 'chat', required
        - `messages` PromptMessage[], required
          - `role` 'user' | 'assistant' | 'model' | 'ai' | 'tool' | 'system' | 'developer', required
          - `content` union, required
            - string
            - union[]
              - …
      - PromptStringTemplate
        - `type` 'string', required
        - `template` string, required
    - `template_type` 'STR' | 'CHAT', required
    - `template_format` 'MUSTACHE' | 'F_STRING' | 'NONE', required
    - `invocation_parameters` union, required
      - PromptOpenAIInvocationParameters
        - `type` 'openai', required
        - `openai` PromptOpenAIInvocationParametersContent, required
          - `temperature` number
          - `max_tokens` integer
          - `max_completion_tokens` integer
          - `frequency_penalty` number
          - `presence_penalty` number
          - `top_p` number
          - `seed` integer
          - `stop` string[]
          - `reasoning_effort` 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh'
          - `extra_body` object
      - PromptAzureOpenAIInvocationParameters
        - `type` 'azure_openai', required
        - `azure_openai` PromptAzureOpenAIInvocationParametersContent, required
          - `temperature` number
          - `max_tokens` integer
          - `max_completion_tokens` integer
          - `frequency_penalty` number
          - `presence_penalty` number
          - `top_p` number
          - `seed` integer
          - `stop` string[]
          - `reasoning_effort` 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh'
          - `extra_body` object
      - PromptAnthropicInvocationParameters
        - `type` 'anthropic', required
        - `anthropic` PromptAnthropicInvocationParametersContent, required
          - `max_tokens` integer, required
          - `temperature` number
          - `top_p` number
          - `stop_sequences` string[]
          - `output_config` PromptAnthropicOutputConfig
            - `effort` 'low' | 'medium' | 'high' | 'xhigh' | 'max'
          - `thinking` union
            - PromptAnthropicThinkingConfigDisabled
              - …
            - PromptAnthropicThinkingConfigEnabled
              - …
            - PromptAnthropicThinkingConfigAdaptive
              - …
          - `extra_body` object
      - PromptGoogleInvocationParameters
        - `type` 'google', required
        - `google` PromptGoogleInvocationParametersContent, required
          - `temperature` number
          - `max_output_tokens` integer
          - `stop_sequences` string[]
          - `presence_penalty` number
          - `frequency_penalty` number
          - `top_p` number
          - `top_k` integer
          - `thinking_config` PromptGoogleThinkingConfig
            - `thinking_budget` integer
            - `thinking_level` 'minimal' | 'low' | 'medium' | 'high'
            - `include_thoughts` boolean
      - PromptDeepSeekInvocationParameters
        - `type` 'deepseek', required
        - `deepseek` PromptDeepSeekInvocationParametersContent, required
          - `temperature` number
          - `max_tokens` integer
          - `max_completion_tokens` integer
          - `frequency_penalty` number
          - `presence_penalty` number
          - `top_p` number
          - `seed` integer
          - `stop` string[]
          - `reasoning_effort` 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh'
          - `extra_body` object
      - PromptXAIInvocationParameters
        - `type` 'xai', required
        - `xai` PromptXAIInvocationParametersContent, required
          - `temperature` number
          - `max_tokens` integer
          - `max_completion_tokens` integer
          - `frequency_penalty` number
          - `presence_penalty` number
          - `top_p` number
          - `seed` integer
          - `stop` string[]
          - `reasoning_effort` 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh'
          - `extra_body` object
      - PromptOllamaInvocationParameters
        - `type` 'ollama', required
        - `ollama` PromptOllamaInvocationParametersContent, required
          - `temperature` number
          - `max_tokens` integer
          - `max_completion_tokens` integer
          - `frequency_penalty` number
          - `presence_penalty` number
          - `top_p` number
          - `seed` integer
          - `stop` string[]
          - `reasoning_effort` 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh'
          - `extra_body` object
      - PromptAwsInvocationParameters
        - `type` 'aws', required
        - `aws` PromptAwsInvocationParametersContent, required
          - `max_tokens` integer
          - `temperature` number
          - `top_p` number
          - `stop_sequences` string[]
      - PromptCerebrasInvocationParameters
        - `type` 'cerebras', required
        - `cerebras` PromptCerebrasInvocationParametersContent, required
          - `temperature` number
          - `max_tokens` integer
          - `max_completion_tokens` integer
          - `frequency_penalty` number
          - `presence_penalty` number
          - `top_p` number
          - `seed` integer
          - `stop` string[]
          - `reasoning_effort` 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh'
          - `extra_body` object
      - PromptFireworksInvocationParameters
        - `type` 'fireworks', required
        - `fireworks` PromptFireworksInvocationParametersContent, required
          - `temperature` number
          - `max_tokens` integer
          - `max_completion_tokens` integer
          - `frequency_penalty` number
          - `presence_penalty` number
          - `top_p` number
          - `seed` integer
          - `stop` string[]
          - `reasoning_effort` 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh'
          - `extra_body` object
      - PromptGroqInvocationParameters
        - `type` 'groq', required
        - `groq` PromptGroqInvocationParametersContent, required
          - `temperature` number
          - `max_tokens` integer
          - `max_completion_tokens` integer
          - `frequency_penalty` number
          - `presence_penalty` number
          - `top_p` number
          - `seed` integer
          - `stop` string[]
          - `reasoning_effort` 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh'
          - `extra_body` object
      - PromptMoonshotInvocationParameters
        - `type` 'moonshot', required
        - `moonshot` PromptMoonshotInvocationParametersContent, required
          - `temperature` number
          - `max_tokens` integer
          - `max_completion_tokens` integer
          - `frequency_penalty` number
          - `presence_penalty` number
          - `top_p` number
          - `seed` integer
          - `stop` string[]
          - `reasoning_effort` 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh'
          - `extra_body` object
      - PromptPerplexityInvocationParameters
        - `type` 'perplexity', required
        - `perplexity` PromptPerplexityInvocationParametersContent, required
          - `temperature` number
          - `max_tokens` integer
          - `max_completion_tokens` integer
          - `frequency_penalty` number
          - `presence_penalty` number
          - `top_p` number
          - `seed` integer
          - `stop` string[]
          - `reasoning_effort` 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh'
          - `extra_body` object
      - PromptTogetherInvocationParameters
        - `type` 'together', required
        - `together` PromptTogetherInvocationParametersContent, required
          - `temperature` number
          - `max_tokens` integer
          - `max_completion_tokens` integer
          - `frequency_penalty` number
          - `presence_penalty` number
          - `top_p` number
          - `seed` integer
          - `stop` string[]
          - `reasoning_effort` 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh'
          - `extra_body` object
    - `tools` PromptTools
      - `type` 'tools', required
      - `tools` union[], required
        - union
          - PromptToolFunction
            - `type` 'function', required
            - `function` PromptToolFunctionDefinition, required
              - …
          - PromptToolRaw
            - `type` 'raw', required
            - `raw` object, required
      - `tool_choice` union
        - PromptToolChoiceNone
          - `type` 'none', required
        - PromptToolChoiceZeroOrMore
          - `type` 'zero_or_more', required
        - PromptToolChoiceOneOrMore
          - `type` 'one_or_more', required
        - PromptToolChoiceSpecificFunctionTool
          - `type` 'specific_function', required
          - `function_name` string, required
      - `disable_parallel_tool_calls` boolean
    - `response_format` PromptResponseFormatJSONSchema
      - `type` 'json_schema', required
      - `json_schema` PromptResponseFormatJSONSchemaDefinition, required
        - `name` string, required
        - `description` string
        - `schema` object
        - `strict` boolean
    - `id` string, required

## Other responses

- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/arize-ai/apis/arize-phoenix-rest-api.md) · [All operations](https://skmtc.net/arize-ai/apis/arize-phoenix-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arize-ai/arize-phoenix-rest-api/versions/a14d8ad6f708/schema)