For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/api/latest/agent-observability/get-an-annotated-queue-interaction.md. A documentation index is available at /llms.txt.
Language
Datadog site

Get an annotated queue interaction

WARNINGNote: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.
GEThttps://api.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id}https://api.us3.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id}https://api.us5.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id}https://api.datadoghq.eu/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id}https://api.ap1.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id}https://api.ap2.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id}https://api.uk1.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id}https://api.ddog-gov.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id}https://api.us2.ddog-gov.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.

Default: 10
cursor
string

Cursor from the previous response to retrieve the next page of events.

Response

OK

Response containing a single annotated interaction and its related events.

Field
Type
Description
data [required]
object

Data object for a single annotated interaction.

Code Example

Get an annotated queue interaction
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
export interaction_id="interaction-456"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/annotated-interactions/${interaction_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
export interaction_id="interaction-456"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/annotated-interactions/${interaction_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
export interaction_id="interaction-456"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/annotated-interactions/${interaction_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
export interaction_id="interaction-456"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/annotated-interactions/${interaction_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
export interaction_id="interaction-456"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/annotated-interactions/${interaction_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
export interaction_id="interaction-456"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/annotated-interactions/${interaction_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
export interaction_id="interaction-456"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/annotated-interactions/${interaction_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
export interaction_id="interaction-456"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/annotated-interactions/${interaction_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
export interaction_id="interaction-456"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/annotated-interactions/${interaction_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"