Agents

Create an agent run and stream the response

Changed on

Executes an agent run and returns the result as a stream of server-sent events (SSE). Note: If the agent uses an input form trigger, all form fields (including optional fields) must be included in the input object.

post/rest/api/v1/agents/runs/stream

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/rest/api/v1/agents/runs/stream
  • Auth: HTTP bearer

Request body

agent_idstring required

The ID of the agent to run.

inputobject

The input to the agent. Required when the agent uses an input form trigger.

metadataobject

The metadata to pass to the agent.

Example request

{
  "messages": [
    {
      "role": "USER"
    }
  ]
}

Response

Success

Changes

  • 3c36e7c6aa0cRevision changes
    • info

      the request property ////// became nullable

    • info

      the request property ////// became nullable

    • info

      the request property //////// became nullable

    • info

      the request property ////// became nullable

  • d265db5a5d6bRevision changes
    • info

      endpoint deprecated