Create Agent Response Log

POST

/api/v2/agents/{agent_id}/responses/log

This endpoint is used to save chat interactions.

Staging behaviour:

Pass agent_version=staging as a query parameter to log the response against the staging version instead of the published agent's.

Path Parameters:

agent_id: ID of the agent for which the response is to be created.

Request Body:

A JSON object with fields to process the chat interaction.

Returns:

JsonResponse: A JSON response containing the result of the chat interaction or an error message.

Current Version:

2.1.0

Changelog:

2.1.0: Added two optional request fields.

skip_billing_event (default false): when true, no metering/billing
event is emitted for this log.

chat_type (text | voice, defaults to text when omitted):
the chat modality persisted on the log.

2.0.0: Initial version.

Request

Path Params

Header Params

Body Params

application/json

Required

Examples

Responses

🟢201Created

application/json

Success

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/agents//responses/log' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
    "chat_thread_id": 0,
    "agent_id": 0,
    "user_id": 0,
    "llm_config_id": 0,
    "question": "string",
    "response": {
        "property1": "string",
        "property2": "string"
    },
    "total_tokens": 0,
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "cache_hit": true,
    "query_source": "web",
    "message_id": "string",
    "guardrail_triggered": true,
    "skip_billing_event": false,
    "chat_type": "text"
}'

Response Example

201 - Example 1

{
    "message": "string",
    "success": true,
    "data": {
        "id": 0,
        "created_by": "string",
        "modified_by": "string",
        "created_on": "2019-08-24T14:15:22.123Z",
        "modified_on": "2019-08-24T14:15:22.123Z",
        "question": "string",
        "response": {
            "property1": "string",
            "property2": "string"
        },
        "is_deleted": true,
        "total_tokens": -2147483648,
        "prompt_tokens": -2147483648,
        "completion_tokens": -2147483648,
        "cache_hit": true,
        "query_source": "string",
        "message_id": "string",
        "cost": "string",
        "pinned": true,
        "guardrail_triggered": true,
        "chat_type": "text",
        "parent": 0,
        "chat_thread": 0,
        "agent": 0,
        "user": 0,
        "llm_config": 0
    }
}

Get Agent Responses of an Agent

Get Pinned Agent Responses