Create an LLM Observability prompt

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

POST https://api.ap1.datadoghq.com/api/v2/llm-obs/v1/promptshttps://api.ap2.datadoghq.com/api/v2/llm-obs/v1/promptshttps://api.datadoghq.eu/api/v2/llm-obs/v1/promptshttps://api.ddog-gov.com/api/v2/llm-obs/v1/promptshttps://api.us2.ddog-gov.com/api/v2/llm-obs/v1/promptshttps://api.uk1.datadoghq.com/api/v2/llm-obs/v1/promptshttps://api.datadoghq.com/api/v2/llm-obs/v1/promptshttps://api.us3.datadoghq.com/api/v2/llm-obs/v1/promptshttps://api.us5.datadoghq.com/api/v2/llm-obs/v1/prompts

Overview

Create a new prompt (and its first version) in the LLM Observability prompt registry. This endpoint requires all of the following permissions:

  • llm_observability_read
  • llm_observability_write
  • feature_flag_config_read
  • feature_flag_config_write
  • feature_flag_environment_config_read

  • Request

    Body Data (required)

    Create prompt payload.

    Expand All

    Field

    Type

    Description

    data [required]

    object

    Data object for creating an LLM Observability prompt.

    attributes [required]

    object

    Attributes for creating an LLM Observability prompt and its first version. prompt_id and template are required; all other attributes are optional.

    description

    string

    Optional description of the prompt.

    env_ids

    [string]

    Optional feature-flag environment UUIDs the service attempts to enable and configure to use the first version as their default after creation.

    labels

    [string]

    DEPRECATED: Optional labels to attach to the first version. Do not use this attribute for new integrations.

    prompt_id [required]

    string

    Customer-provided identifier for the new prompt.

    template [required]

     <oneOf>

    A text template or a list of chat messages.

    Object 1

    string

    A text prompt template.

    Object 2

    [object]

    A chat prompt template.

    content [required]

    string

    Content of the message.

    role [required]

    string

    Role of the message (for example system, user, or assistant).

    title

    string

    Optional title of the prompt.

    user_version

    string

    Optional user-supplied version identifier for the first version.

    type [required]

    enum

    Resource type of an LLM Observability prompt. Allowed enum values: prompt-templates

    {
      "data": {
        "attributes": {
          "prompt_id": "Example-LLM-Observability",
          "title": "Customer Support Assistant",
          "template": [
            {
              "content": "You are a helpful customer support assistant for {{company_name}}.",
              "role": "system"
            },
            {
              "content": "Help {{customer_name}} with this question: {{question}}",
              "role": "user"
            }
          ]
        },
        "type": "prompt-templates"
      }
    }

    Response

    OK

    Response containing a single LLM Observability prompt.

    Expand All

    Field

    Type

    Description

    data [required]

    object

    Data object for an LLM Observability prompt.

    attributes [required]

    object

    Attributes of an LLM Observability prompt registry entry.

    author

    string

    UUID of the user who authored the prompt.

    created_at

    date-time

    Timestamp when the prompt was created.

    created_from [required]

    string

    Source that created the prompt, such as ui-registry, sdk-registry, or sdk-instrumentation.

    datasets

    [object]

    Datasets observed in runs associated with this prompt.

    id [required]

    string

    Unique identifier of the dataset.

    name

    string

    Name of the dataset.

    description

    string

    Description of the prompt.

    extracted_from

    string

    Source prompt from which this prompt was extracted, when applicable.

    in_registry [required]

    boolean

    Whether the prompt is a registry entry (as opposed to a code-discovered prompt).

    last_seen_at

    date-time

    Timestamp of the most recent observed run of this prompt.

    last_version_created_at

    date-time

    Timestamp when the most recent version of the prompt was created.

    ml_app

    string

    The ML application this prompt is associated with.

    ml_apps

    [string]

    ML applications observed running this prompt.

    num_versions [required]

    int64

    Number of versions of the prompt.

    prompt_id [required]

    string

    Customer-provided identifier of the prompt.

    source [required]

    enum

    Whether the prompt was created from the registry or discovered from observed LLM calls. Allowed enum values: registry,code

    tags

    [string]

    Tags observed on runs of this prompt.

    title

    string

    Title of the prompt.

    id [required]

    string

    Unique identifier of the prompt.

    type [required]

    enum

    Resource type of an LLM Observability prompt. Allowed enum values: prompt-templates

    {
      "data": {
        "attributes": {
          "author": "3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e",
          "created_at": "2025-01-15T10:00:00Z",
          "created_from": "sdk-registry",
          "description": "Answers customer questions using the company knowledge base.",
          "in_registry": true,
          "last_version_created_at": "2025-01-15T10:00:00Z",
          "num_versions": 1,
          "prompt_id": "customer-support-assistant",
          "source": "registry",
          "title": "Customer Support Assistant"
        },
        "id": "4a1a28ff-8a25-5f0f-946f-f48264d772eb",
        "type": "prompt-templates"
      }
    }

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
      "errors": [
        {
          "detail": "Missing required attribute in body",
          "meta": {},
          "source": {
            "header": "Authorization",
            "parameter": "limit",
            "pointer": "/data/attributes/title"
          },
          "status": "400",
          "title": "Bad Request"
        }
      ]
    }

    Unauthorized

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
      "errors": [
        {
          "detail": "Missing required attribute in body",
          "meta": {},
          "source": {
            "header": "Authorization",
            "parameter": "limit",
            "pointer": "/data/attributes/title"
          },
          "status": "400",
          "title": "Bad Request"
        }
      ]
    }

    Forbidden

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
      "errors": [
        {
          "detail": "Missing required attribute in body",
          "meta": {},
          "source": {
            "header": "Authorization",
            "parameter": "limit",
            "pointer": "/data/attributes/title"
          },
          "status": "400",
          "title": "Bad Request"
        }
      ]
    }

    Conflict

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
      "errors": [
        {
          "detail": "Missing required attribute in body",
          "meta": {},
          "source": {
            "header": "Authorization",
            "parameter": "limit",
            "pointer": "/data/attributes/title"
          },
          "status": "400",
          "title": "Bad Request"
        }
      ]
    }

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Code Example

                              ## default
    # 
    
    # Curl command
    curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/llm-obs/v1/prompts" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "description": "Answers customer questions using the company knowledge base.", "prompt_id": "customer-support-assistant", "template": [ { "content": "You are a helpful customer support assistant for {{company_name}}.", "role": "system" }, { "content": "Help {{customer_name}} with this question: {{question}}", "role": "user" } ], "title": "Customer Support Assistant" }, "type": "prompt-templates" } } EOF
    // Create an LLM Observability prompt 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() {
    	body := datadogV2.LLMObsCreatePromptRequest{
    		Data: datadogV2.LLMObsCreatePromptData{
    			Attributes: datadogV2.LLMObsCreatePromptDataAttributes{
    				PromptId: "Example-LLM-Observability",
    				Title:    datadog.PtrString("Customer Support Assistant"),
    				Template: datadogV2.LLMObsPromptTemplate{
    					LLMObsPromptChatTemplate: &datadogV2.LLMObsPromptChatTemplate{Items: []datadogV2.LLMObsPromptChatMessage{
    						{
    							Content: "You are a helpful customer support assistant for {{company_name}}.",
    							Role:    "system",
    						},
    						{
    							Content: "Help {{customer_name}} with this question: {{question}}",
    							Role:    "user",
    						},
    					}}},
    			},
    			Type: datadogV2.LLMOBSPROMPTTYPE_PROMPT_TEMPLATES,
    		},
    	}
    	ctx := datadog.NewDefaultContext(context.Background())
    	configuration := datadog.NewConfiguration()
    	configuration.SetUnstableOperationEnabled("v2.CreateLLMObsPrompt", true)
    	apiClient := datadog.NewAPIClient(configuration)
    	api := datadogV2.NewLLMObservabilityApi(apiClient)
    	resp, r, err := api.CreateLLMObsPrompt(ctx, body)
    
    	if err != nil {
    		fmt.Fprintf(os.Stderr, "Error when calling `LLMObservabilityApi.CreateLLMObsPrompt`: %v\n", err)
    		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    	}
    
    	responseContent, _ := json.MarshalIndent(resp, "", "  ")
    	fmt.Fprintf(os.Stdout, "Response from `LLMObservabilityApi.CreateLLMObsPrompt`:\n%s\n", responseContent)
    }
    

    Instructions

    First install the library and its dependencies and then save the example to main.go and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
    // Create an LLM Observability prompt returns "OK" response
    
    import com.datadog.api.client.ApiClient;
    import com.datadog.api.client.ApiException;
    import com.datadog.api.client.v2.api.LlmObservabilityApi;
    import com.datadog.api.client.v2.model.LLMObsCreatePromptData;
    import com.datadog.api.client.v2.model.LLMObsCreatePromptDataAttributes;
    import com.datadog.api.client.v2.model.LLMObsCreatePromptRequest;
    import com.datadog.api.client.v2.model.LLMObsPromptChatMessage;
    import com.datadog.api.client.v2.model.LLMObsPromptChatTemplate;
    import com.datadog.api.client.v2.model.LLMObsPromptResponse;
    import com.datadog.api.client.v2.model.LLMObsPromptTemplate;
    import com.datadog.api.client.v2.model.LLMObsPromptType;
    import java.util.Arrays;
    
    public class Example {
      public static void main(String[] args) {
        ApiClient defaultClient = ApiClient.getDefaultApiClient();
        defaultClient.setUnstableOperationEnabled("v2.createLLMObsPrompt", true);
        LlmObservabilityApi apiInstance = new LlmObservabilityApi(defaultClient);
    
        LLMObsCreatePromptRequest body =
            new LLMObsCreatePromptRequest()
                .data(
                    new LLMObsCreatePromptData()
                        .attributes(
                            new LLMObsCreatePromptDataAttributes()
                                .promptId("Example-LLM-Observability")
                                .title("Customer Support Assistant")
                                .template(
                                    new LLMObsPromptTemplate(
                                        new LLMObsPromptChatTemplate(
                                            Arrays.asList(
                                                new LLMObsPromptChatMessage()
                                                    .content(
                                                        "You are a helpful customer support assistant"
                                                            + " for {{company_name}}.")
                                                    .role("system"),
                                                new LLMObsPromptChatMessage()
                                                    .content(
                                                        "Help {{customer_name}} with this question:"
                                                            + " {{question}}")
                                                    .role("user"))))))
                        .type(LLMObsPromptType.PROMPT_TEMPLATES));
    
        try {
          LLMObsPromptResponse result = apiInstance.createLLMObsPrompt(body);
          System.out.println(result);
        } catch (ApiException e) {
          System.err.println("Exception when calling LlmObservabilityApi#createLLMObsPrompt");
          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 and then save the example to Example.java and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
    """
    Create an LLM Observability prompt returns "OK" response
    """
    
    from datadog_api_client import ApiClient, Configuration
    from datadog_api_client.v2.api.llm_observability_api import LLMObservabilityApi
    from datadog_api_client.v2.model.llm_obs_create_prompt_data import LLMObsCreatePromptData
    from datadog_api_client.v2.model.llm_obs_create_prompt_data_attributes import LLMObsCreatePromptDataAttributes
    from datadog_api_client.v2.model.llm_obs_create_prompt_request import LLMObsCreatePromptRequest
    from datadog_api_client.v2.model.llm_obs_prompt_chat_message import LLMObsPromptChatMessage
    from datadog_api_client.v2.model.llm_obs_prompt_type import LLMObsPromptType
    
    body = LLMObsCreatePromptRequest(
        data=LLMObsCreatePromptData(
            attributes=LLMObsCreatePromptDataAttributes(
                prompt_id="Example-LLM-Observability",
                title="Customer Support Assistant",
                template=[
                    LLMObsPromptChatMessage(
                        content="You are a helpful customer support assistant for {{company_name}}.",
                        role="system",
                    ),
                    LLMObsPromptChatMessage(
                        content="Help {{customer_name}} with this question: {{question}}",
                        role="user",
                    ),
                ],
            ),
            type=LLMObsPromptType.PROMPT_TEMPLATES,
        ),
    )
    
    configuration = Configuration()
    configuration.unstable_operations["create_llm_obs_prompt"] = True
    with ApiClient(configuration) as api_client:
        api_instance = LLMObservabilityApi(api_client)
        response = api_instance.create_llm_obs_prompt(body=body)
    
        print(response)
    

    Instructions

    First install the library and its dependencies and then save the example to example.py and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
    # Create an LLM Observability prompt returns "OK" response
    
    require "datadog_api_client"
    DatadogAPIClient.configure do |config|
      config.unstable_operations["v2.create_llm_obs_prompt".to_sym] = true
    end
    api_instance = DatadogAPIClient::V2::LLMObservabilityAPI.new
    
    body = DatadogAPIClient::V2::LLMObsCreatePromptRequest.new({
      data: DatadogAPIClient::V2::LLMObsCreatePromptData.new({
        attributes: DatadogAPIClient::V2::LLMObsCreatePromptDataAttributes.new({
          prompt_id: "Example-LLM-Observability",
          title: "Customer Support Assistant",
          template: [
            DatadogAPIClient::V2::LLMObsPromptChatMessage.new({
              content: "You are a helpful customer support assistant for {{company_name}}.",
              role: "system",
            }),
            DatadogAPIClient::V2::LLMObsPromptChatMessage.new({
              content: "Help {{customer_name}} with this question: {{question}}",
              role: "user",
            }),
          ],
        }),
        type: DatadogAPIClient::V2::LLMObsPromptType::PROMPT_TEMPLATES,
      }),
    })
    p api_instance.create_llm_obs_prompt(body)
    

    Instructions

    First install the library and its dependencies and then save the example to example.rb and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
    // Create an LLM Observability prompt returns "OK" response
    use datadog_api_client::datadog;
    use datadog_api_client::datadogV2::api_llm_observability::LLMObservabilityAPI;
    use datadog_api_client::datadogV2::model::LLMObsCreatePromptData;
    use datadog_api_client::datadogV2::model::LLMObsCreatePromptDataAttributes;
    use datadog_api_client::datadogV2::model::LLMObsCreatePromptRequest;
    use datadog_api_client::datadogV2::model::LLMObsPromptChatMessage;
    use datadog_api_client::datadogV2::model::LLMObsPromptTemplate;
    use datadog_api_client::datadogV2::model::LLMObsPromptType;
    
    #[tokio::main]
    async fn main() {
        let body = LLMObsCreatePromptRequest::new(LLMObsCreatePromptData::new(
            LLMObsCreatePromptDataAttributes::new(
                "Example-LLM-Observability".to_string(),
                LLMObsPromptTemplate::LLMObsPromptChatTemplate(vec![
                    LLMObsPromptChatMessage::new(
                        "You are a helpful customer support assistant for {{company_name}}."
                            .to_string(),
                        "system".to_string(),
                    ),
                    LLMObsPromptChatMessage::new(
                        "Help {{customer_name}} with this question: {{question}}".to_string(),
                        "user".to_string(),
                    ),
                ]),
            )
            .title("Customer Support Assistant".to_string()),
            LLMObsPromptType::PROMPT_TEMPLATES,
        ));
        let mut configuration = datadog::Configuration::new();
        configuration.set_unstable_operation_enabled("v2.CreateLLMObsPrompt", true);
        let api = LLMObservabilityAPI::with_config(configuration);
        let resp = api.create_llm_obs_prompt(body).await;
        if let Ok(value) = resp {
            println!("{:#?}", value);
        } else {
            println!("{:#?}", resp.unwrap_err());
        }
    }
    

    Instructions

    First install the library and its dependencies and then save the example to src/main.rs and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
    /**
     * Create an LLM Observability prompt returns "OK" response
     */
    
    import { client, v2 } from "@datadog/datadog-api-client";
    
    const configuration = client.createConfiguration();
    configuration.unstableOperations["v2.createLLMObsPrompt"] = true;
    const apiInstance = new v2.LLMObservabilityApi(configuration);
    
    const params: v2.LLMObservabilityApiCreateLLMObsPromptRequest = {
      body: {
        data: {
          attributes: {
            promptId: "Example-LLM-Observability",
            title: "Customer Support Assistant",
            template: [
              {
                content:
                  "You are a helpful customer support assistant for {{company_name}}.",
                role: "system",
              },
              {
                content: "Help {{customer_name}} with this question: {{question}}",
                role: "user",
              },
            ],
          },
          type: "prompt-templates",
        },
      },
    };
    
    apiInstance
      .createLLMObsPrompt(params)
      .then((data: v2.LLMObsPromptResponse) => {
        console.log(
          "API called successfully. Returned data: " + JSON.stringify(data)
        );
      })
      .catch((error: any) => console.error(error));
    

    Instructions

    First install the library and its dependencies and then save the example to example.ts and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"