--- title: Get an annotated queue interaction 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 an annotated queue interaction{% #get-an-annotated-queue-interaction %} {% 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/annotation-queues/{queue_id}/annotated-interactions/{interaction_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id} | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id} | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id} | ### Overview Retrieve an interaction, its annotations, and a page of related events from an annotation queue. ### Arguments #### Path Parameters | Name | Type | Description | | -------------------------------- | ------ | --------------------------------------------------- | | queue_id [*required*] | string | The ID of the Agent Observability annotation queue. | | interaction_id [*required*] | string | The ID of the interaction in the annotation queue. | #### Query Strings | Name | Type | Description | | ------ | ------- | ---------------------------------------------------------------------- | | limit | integer | Maximum number of events to return. Defaults to 10. | | cursor | string | Cursor from the previous response to retrieve the next page of events. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing a single annotated interaction and its related events. | Parent field | Field | Type | Description | | --------------------- | --------------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Data object for a single annotated interaction. | | data | attributes [*required*] | object | Attributes containing an annotated interaction and its related events. | | attributes | annotated_interaction [*required*] | | An interaction with its associated annotations. | | annotated_interaction | Object 1 | object | A trace, experiment trace, or session interaction with its associated annotations. | | Object 1 | annotations [*required*] | [object] | List of annotations for this interaction. | | annotations | created_at [*required*] | date-time | Timestamp when the annotation was created. | | annotations | created_by [*required*] | string | Identifier of the user who created the annotation. | | annotations | id [*required*] | string | Unique identifier of the annotation. | | annotations | interaction_id [*required*] | string | Identifier of the interaction this annotation belongs to. | | annotations | label_values [*required*] | object | Label values for this annotation. | | annotations | modified_at [*required*] | date-time | Timestamp when the annotation was last modified. | | annotations | modified_by [*required*] | string | Identifier of the user who last modified the annotation. | | Object 1 | can_annotate [*required*] | boolean | Whether the current caller can annotate this interaction. | | Object 1 | content_id [*required*] | string | Upstream entity identifier supplied by the caller. | | Object 1 | created_at [*required*] | date-time | Timestamp when the interaction was added to the queue. | | Object 1 | id [*required*] | string | Unique identifier of the interaction. | | Object 1 | modified_at [*required*] | date-time | Timestamp when the interaction was last updated. | | Object 1 | type [*required*] | enum | Type of an upstream-entity interaction. Allowed enum values: `trace,experiment_trace,session` | | annotated_interaction | | object | A display_block interaction with its associated annotations. | | | annotations [*required*] | [object] | List of annotations for this interaction. | | annotations | created_at [*required*] | date-time | Timestamp when the annotation was created. | | annotations | created_by [*required*] | string | Identifier of the user who created the annotation. | | annotations | id [*required*] | string | Unique identifier of the annotation. | | annotations | interaction_id [*required*] | string | Identifier of the interaction this annotation belongs to. | | annotations | label_values [*required*] | object | Label values for this annotation. | | annotations | modified_at [*required*] | date-time | Timestamp when the annotation was last modified. | | annotations | modified_by [*required*] | string | Identifier of the user who last modified the annotation. | | | can_annotate [*required*] | boolean | Whether the current caller can annotate this interaction. | | | content_id [*required*] | string | Server-generated deterministic identifier derived from the block list. | | | display_block [*required*] | [object] | List of content blocks that make up a `display_block` interaction. Must contain at least one block. | | display_block | alt | string | Alternative text for an `image` block. | | display_block | code | string | HTML code rendered by a `frontend` block. Required for `frontend` blocks. | | display_block | content | | Block payload. A string for `markdown`, `header`, and `text`; an arbitrary JSON value (object, array, or scalar) for `json`. Omitted for `image`, `widget`, `llmobs_trace`, and `frontend`. | | display_block | height | int64 | Optional rendered height. Must be positive when set. | | display_block | interactionType | enum | Upstream interaction type referenced by an `llmobs_trace` block. Restricted to `trace` or `experiment_trace`. Allowed enum values: `trace,experiment_trace` | | display_block | label | string | Optional label rendered alongside a `frontend` block. | | display_block | level | enum | Visual size for a `header` block. Allowed enum values: `sm,md,lg,xl` | | display_block | tileDef | | Tile definition for a `widget` block. Required for `widget`. The schema is owned by the frontend renderer. | | display_block | timeFrame | object | Unix-millis time range used by chart blocks. | | timeFrame | end [*required*] | int64 | End of the range, in Unix milliseconds. | | timeFrame | start [*required*] | int64 | Start of the range, in Unix milliseconds. | | display_block | traceId | string | Trace identifier. Required for `llmobs_trace` blocks. | | display_block | type [*required*] | enum | Discriminator for a single `display_block` content block. Adding a variant requires coordinated changes in the frontend renderer. Allowed enum values: `markdown,header,text,json,image,widget,llmobs_trace,frontend` | | display_block | url | string | URL of the image. Required for `image` blocks. | | | id [*required*] | string | Unique identifier of the interaction. | | | type [*required*] | enum | Type discriminator for a `display_block` interaction. Allowed enum values: `display_block` | | attributes | events [*required*] | [object] | Page of events associated with the annotated interaction. | | events | attributes [*required*] | object | Attributes of an event associated with an annotated interaction. | | events | id [*required*] | string | Unique identifier of the event. | | events | type [*required*] | string | Type of the event. | | attributes | interaction_type [*required*] | enum | Type of an annotated interaction. Allowed enum values: `trace,experiment_trace,session,display_block` | | attributes | next_cursor | string | Cursor to retrieve the next page of events. Absent when there are no more events. | | data | id [*required*] | string | Unique identifier of the interaction. | | data | type [*required*] | enum | Resource type for annotated interactions. Allowed enum values: `annotated_interactions` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "annotated_interaction": { "annotations": [ { "created_at": "2024-01-15T10:30:00Z", "created_by": "00000000-0000-0000-0000-000000000002", "id": "annotation-789", "interaction_id": "interaction-456", "label_values": [ {} ], "modified_at": "2024-01-15T10:30:00Z", "modified_by": "00000000-0000-0000-0000-000000000002" } ], "can_annotate": true, "content_id": "trace-abc-123", "created_at": "2024-01-15T10:30:00Z", "id": "interaction-456", "modified_at": "2024-01-15T10:30:00Z", "type": "trace" }, "events": [ { "attributes": { "duration": 1500000000, "ml_app": "my-llm-app", "name": "agent_workflow", "span_id": "span-7a1b2c3d", "span_kind": "agent", "start_ns": 1705314600000000000, "status": "ok", "trace_id": "trace-abc-123" }, "id": "span-7a1b2c3d", "type": "span" } ], "interaction_type": "trace", "next_cursor": "eyJzdGFydCI6MTAwfQ==" }, "id": "interaction-456", "type": "annotated_interactions" } } ``` {% /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 queue_id="00000000-0000-0000-0000-000000000001" export interaction_id="interaction-456" \# 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/annotation-queues/${queue_id}/annotated-interactions/${interaction_id}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ##### ```python """ Get an annotated queue interaction 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_annotated_interaction"] = True with ApiClient(configuration) as api_client: api_instance = AgentObservabilityApi(api_client) response = api_instance.get_llm_obs_annotated_interaction( queue_id="queue_id", interaction_id="interaction_id", ) 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 an annotated queue interaction 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_annotated_interaction".to_sym] = true end api_instance = DatadogAPIClient::V2::AgentObservabilityAPI.new p api_instance.get_llm_obs_annotated_interaction("queue_id", "interaction_id") ``` #### 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 an annotated queue interaction 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.GetLLMObsAnnotatedInteraction", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewAgentObservabilityApi(apiClient) resp, r, err := api.GetLLMObsAnnotatedInteraction(ctx, "queue_id", "interaction_id", *datadogV2.NewGetLLMObsAnnotatedInteractionOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AgentObservabilityApi.GetLLMObsAnnotatedInteraction`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `AgentObservabilityApi.GetLLMObsAnnotatedInteraction`:\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 an annotated queue interaction 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.LLMObsAnnotatedInteractionResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.getLLMObsAnnotatedInteraction", true); AgentObservabilityApi apiInstance = new AgentObservabilityApi(defaultClient); try { LLMObsAnnotatedInteractionResponse result = apiInstance.getLLMObsAnnotatedInteraction( "00000000-0000-0000-0000-000000000001", "interaction-456"); System.out.println(result); } catch (ApiException e) { System.err.println( "Exception when calling AgentObservabilityApi#getLLMObsAnnotatedInteraction"); 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 an annotated queue interaction returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_agent_observability::AgentObservabilityAPI; use datadog_api_client::datadogV2::api_agent_observability::GetLLMObsAnnotatedInteractionOptionalParams; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.GetLLMObsAnnotatedInteraction", true); let api = AgentObservabilityAPI::with_config(configuration); let resp = api .get_llm_obs_annotated_interaction( "queue_id".to_string(), "interaction_id".to_string(), GetLLMObsAnnotatedInteractionOptionalParams::default(), ) .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 an annotated queue interaction 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.getLLMObsAnnotatedInteraction"] = true; const apiInstance = new v2.AgentObservabilityApi(configuration); const params: v2.AgentObservabilityApiGetLLMObsAnnotatedInteractionRequest = { queueId: "queue_id", interactionId: "interaction_id", }; apiInstance .getLLMObsAnnotatedInteraction(params) .then((data: v2.LLMObsAnnotatedInteractionResponse) => { 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 %}