Agents

Create an agent run and wait for the response

Changed on

Executes an agent run and returns the final response. 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/wait

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/rest/api/v1/agents/runs/wait
  • 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

  • 31c4fd74a143Revision changes
    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property //////// became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property /////////// became nullable for the status

    • breaking

      the response property /////////// became nullable for the status

    • breaking

      the response property ///////////// became nullable for the status

    • breaking

      the response property /////////// became nullable for the status

    • info

      the request property ////// became nullable

    • info

      the request property ////// became nullable

    • info

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

    • info

      the request property ////// became nullable

  • 3802728b3c66Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ///////// to the response with the status