Some products and features are in the process of being renamed. Generative playbook and flow features are also being migrated to a single consolidated console. See the details.
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.
HTTP request
POST https://{endpoint}/v3/{session=projects/*/locations/*/agents/*/sessions/*}:serverStreamingDetectIntent
Required. The name of the session this query is sent to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<Session
ID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis document describes how to use the \u003ccode\u003eserverStreamingDetectIntent\u003c/code\u003e method to process natural language queries and receive structured data via server-side streaming.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a POST request to a specific endpoint with a structured URL that follows gRPC Transcoding syntax, requiring a \u003ccode\u003esession\u003c/code\u003e path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esession\u003c/code\u003e path parameter is required and must be formatted correctly, with the caller being responsible for choosing an appropriate \u003ccode\u003eSession ID\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body accepts parameters for \u003ccode\u003equeryParams\u003c/code\u003e, \u003ccode\u003equeryInput\u003c/code\u003e, and \u003ccode\u003eoutputAudioConfig\u003c/code\u003e, detailing the structure and specific parameters that can be passed.\u003c/p\u003e\n"],["\u003cp\u003eThe response is a stream of \u003ccode\u003eDetectIntentResponse\u003c/code\u003e instances, and the request requires one of the listed OAuth scopes for authorization.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.agents.sessions.serverStreamingDetectIntent\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nProcesses a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) earlier in a single request.\n\n### HTTP request\n\n`POST https://{endpoint}/v3/{session=projects/*/locations/*/agents/*/sessions/*}:serverStreamingDetectIntent`\n\nWhere `{endpoint}` is one of the [supported service endpoints](/dialogflow/cx/docs/reference/rest#rest_endpoints).\n\nThe URLs use [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains a stream of [DetectIntentResponse](/dialogflow/cx/docs/reference/rest/v3/DetectIntentResponse) instances.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/dialogflow`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
