--- title: Get a specific Agent Observability prompt version description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Agent Observability --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). # Get a specific Agent Observability prompt version{% #get-a-specific-agent-observability-prompt-version %} Copy pageCopied {% tab title="v2" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------------------------ | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version} | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version} | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/llm-obs/v1/prompts/{prompt_id}/versions/{version} | ### Overview Get the full template and configuration of a single, specific version of an Agent Observability prompt. This endpoint requires the `llm_observability_read` permission. ### Arguments #### Path Parameters | Name | Type | Description | | --------------------------- | ------- | ------------------------------------------------------------------- | | prompt_id [*required*] | string | The customer-provided identifier of the Agent Observability prompt. | | version [*required*] | integer | The version number of the Agent Observability prompt. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing a specific version of an Agent Observability prompt. | Parent field | Field | Type | Description | | ------------------ | ----------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | Data object for a specific version of an Agent Observability prompt. | | data | attributes [*required*] | object | Attributes of a specific version of an Agent Observability prompt. For a composed version, `authoring_template` contains its pinned include-bearing source; ordinary versions omit that attribute. Empty `config` is omitted when configuration authoring is disabled for the organization. Non-empty saved configuration is always returned. | | attributes | author | string | UUID of the user who authored this version. | | attributes | authoring_template | | A text template, a list of chat messages, or an authored chat object. Text can include an exact prompt version with `{{>prompt-id version=N}}`; other text, including `{{>...}}` sequences without a version, remains literal. Use an authored chat object when including prompts as chat messages. **Preview**: Prompt composition is available in Preview. To request access, contact [Datadog Support](https://docs.datadoghq.com/help/) or your Customer Success Manager. Without access, inline references remain literal text and structured includes are unsupported. Previously compiled prompt versions remain available for execution. | | authoring_template | Object 1 | string | A text prompt template. | | authoring_template | Object 2 | [object] | A chat prompt template. | | Object 2 | content [*required*] | string | Content of the message. | | Object 2 | role [*required*] | string | Role of the message (for example `system`, `user`, or `assistant`). | | authoring_template | Object 3 | object | A chat prompt whose authored items are stored under `messages`. | | Object 3 | messages [*required*] | [ ] | A chat prompt containing messages, references to specific versions of other prompts, or both. | | messages | Object 1 | object | A single chat message in a prompt template. | | Object 1 | content [*required*] | string | Content of the message. | | Object 1 | role [*required*] | string | Role of the message (for example `system`, `user`, or `assistant`). | | messages | Object 2 | object | Includes all or selected messages from a specific version of another prompt. | | Object 2 | include [*required*] | object | Includes messages from a specific version of another prompt. Omitting `items` includes every message from that version in its original order. When `items` is present, messages are included in the specified order, including repetitions. | | include | items | [integer] | Zero-based indexes of messages from the included prompt. For example, `[2, 0, 0]` includes the third message, followed by the first message twice. Omit this field to include all messages in their original order. | | include | prompt_id [*required*] | string | Customer-provided identifier of the included prompt. | | include | version [*required*] | int64 | Positive sequential version number of the included prompt. | | attributes | config | object | Versioned prompt configuration is in Preview. To request access, contact [Datadog Support](https://www.datadoghq.com/support/) or your Customer Success Manager. Customer-owned configuration delivered with a prompt version. Datadog stores and returns the object without interpolating it, validating provider-specific keys, or applying it to model calls. Do not include secrets. | | attributes | created_at | date-time | Timestamp stored on this prompt version. | | attributes | datasets | [object] | Datasets observed in runs associated with this prompt version. | | datasets | id [*required*] | string | Unique identifier of the dataset. | | datasets | name | string | Name of the dataset. | | attributes | description | string | Description of this version. | | attributes | labels | [string] | **DEPRECATED**: Labels attached to this version (for example `development`, `staging`, `production`). | | attributes | last_seen_at | date-time | Timestamp of the most recent observed run of this prompt version. | | attributes | ml_app | string | The ML application this prompt is associated with. | | attributes | ml_apps | [string] | ML applications observed running this prompt version. | | attributes | prompt_id [*required*] | string | Customer-provided identifier of the parent prompt. | | attributes | prompt_uuid [*required*] | string | Unique identifier of the parent prompt. | | attributes | tags | [string] | Tags observed on runs of this prompt version. | | attributes | template [*required*] | | A text template, a list of chat messages, or an authored chat object. Text can include an exact prompt version with `{{>prompt-id version=N}}`; other text, including `{{>...}}` sequences without a version, remains literal. Use an authored chat object when including prompts as chat messages. **Preview**: Prompt composition is available in Preview. To request access, contact [Datadog Support](https://docs.datadoghq.com/help/) or your Customer Success Manager. Without access, inline references remain literal text and structured includes are unsupported. Previously compiled prompt versions remain available for execution. | | template | Object 1 | string | A text prompt template. | | template | Object 2 | [object] | A chat prompt template. | | Object 2 | content [*required*] | string | Content of the message. | | Object 2 | role [*required*] | string | Role of the message (for example `system`, `user`, or `assistant`). | | template | Object 3 | object | A chat prompt whose authored items are stored under `messages`. | | Object 3 | messages [*required*] | [ ] | A chat prompt containing messages, references to specific versions of other prompts, or both. | | messages | Object 1 | object | A single chat message in a prompt template. | | Object 1 | content [*required*] | string | Content of the message. | | Object 1 | role [*required*] | string | Role of the message (for example `system`, `user`, or `assistant`). | | messages | Object 2 | object | Includes all or selected messages from a specific version of another prompt. | | Object 2 | include [*required*] | object | Includes messages from a specific version of another prompt. Omitting `items` includes every message from that version in its original order. When `items` is present, messages are included in the specified order, including repetitions. | | include | items | [integer] | Zero-based indexes of messages from the included prompt. For example, `[2, 0, 0]` includes the third message, followed by the first message twice. Omit this field to include all messages in their original order. | | include | prompt_id [*required*] | string | Customer-provided identifier of the included prompt. | | include | version [*required*] | int64 | Positive sequential version number of the included prompt. | | attributes | user_version | string | User-supplied identifier for this version. | | attributes | version [*required*] | int64 | Sequential version number. | | attributes | version_created_at | date-time | Timestamp when this version was created. | | data | id [*required*] | string | Unique identifier of the prompt version. | | data | type [*required*] | enum | Resource type of an Agent Observability prompt version. Allowed enum values: `prompt-template-versions` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "author": "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e", "config": {}, "created_at": "2025-02-01T14:30:00Z", "description": "Give concise answers and cite relevant help-center articles.", "prompt_id": "customer-support-assistant", "prompt_uuid": "4a1a28ff-8a25-5f0f-946f-f48264d772eb", "template": [ { "content": "You are a helpful customer support assistant for {{company_name}}.", "role": "system" }, { "content": "Help {{customer_name}} with this question: {{question}}", "role": "user" } ], "version": 2, "version_created_at": "2025-02-01T14:30:00Z" }, "id": "d83ab666-61cc-5545-a83b-2424bb85467b", "type": "prompt-template-versions" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parameters export prompt_id="customer-support-assistant" export version="1" \# Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/llm-obs/v1/prompts/${prompt_id}/versions/${version}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ##### ```python """ Get a specific Agent Observability prompt version returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.agent_observability_api import AgentObservabilityApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] configuration.unstable_operations["get_llm_obs_prompt_version"] = True with ApiClient(configuration) as api_client: api_instance = AgentObservabilityApi(api_client) response = api_instance.get_llm_obs_prompt_version( prompt_id="prompt_id", version=9223372036854775807, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ##### ```ruby # Get a specific Agent Observability prompt version returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] config.unstable_operations["v2.get_llm_obs_prompt_version".to_sym] = true end api_instance = DatadogAPIClient::V2::AgentObservabilityAPI.new p api_instance.get_llm_obs_prompt_version("prompt_id", 9223372036854775807) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ##### ```go // Get a specific Agent Observability prompt version returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.GetLLMObsPromptVersion", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewAgentObservabilityApi(apiClient) resp, r, err := api.GetLLMObsPromptVersion(ctx, "prompt_id", 9223372036854775807) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AgentObservabilityApi.GetLLMObsPromptVersion`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `AgentObservabilityApi.GetLLMObsPromptVersion`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ##### ```java // Get a specific Agent Observability prompt version returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.AgentObservabilityApi; import com.datadog.api.client.v2.model.LLMObsPromptVersionResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.getLLMObsPromptVersion", true); AgentObservabilityApi apiInstance = new AgentObservabilityApi(defaultClient); try { LLMObsPromptVersionResponse result = apiInstance.getLLMObsPromptVersion("customer-support-assistant", 1L); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AgentObservabilityApi#getLLMObsPromptVersion"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ##### ```rust // Get a specific Agent Observability prompt version returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_agent_observability::AgentObservabilityAPI; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.GetLLMObsPromptVersion", true); let api = AgentObservabilityAPI::with_config(configuration); let resp = api .get_llm_obs_prompt_version("prompt_id".to_string(), 9223372036854775807) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get a specific Agent Observability prompt version returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); configuration.unstableOperations["v2.getLLMObsPromptVersion"] = true; const apiInstance = new v2.AgentObservabilityApi(configuration); const params: v2.AgentObservabilityApiGetLLMObsPromptVersionRequest = { promptId: "prompt_id", version: 9223372036854775807, }; apiInstance .getLLMObsPromptVersion(params) .then((data: v2.LLMObsPromptVersionResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" {% /tab %}