Generate Agent Response (Non-Streaming)

POST

/response-service/api/v2/agents/{agent_id}/responses

Allows generating a new response from a specific agent based on user input. This endpoint processes the user's query, utilizes AI models, and optionally retrieves information from predefined sources before returning a response.

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

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

Current Version

2.0.0

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Successfully fetched the response

Body

🟠400Bad Request

🟠422Parameter Error

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///response-service/api/v2/agents//responses' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "caching_enabled": false,
    "chat_thread_id": 1,
    "created_by": "[email protected]",
    "history": [
        {
            "bot": "Paris is the capital of France.",
            "user": "What is the capital of France?"
        }
    ],
    "is_file_attached": false,
    "overrides": {
        "corpus_ids": [
            1
        ],
        "log_intermediate_response": true,
        "retrieve_data_points": true
    },
    "query_source": "web",
    "user_query": "and what about the weather?"
}'

Response Example

200 - Example 1

{
    "data": {
        "agent_response_id": 1,
        "answer": "The capital of France is Paris.",
        "artifacts": [],
        "blocked": false,
        "cache_hit": false,
        "chat_thread_name": "Chat Thread Name",
        "references": [],
        "thread_id": 1
    },
    "message": "Successfully fetched the response",
    "success": true
}

Stream Agent Response (SSE)

Create Agent Response