Sign in

Send a message to an agent

Sends a message to a deployed agent and returns a job ID that can be used to poll for the response. Requires the api:agent:message:* scope.

post/agents/sendMessage

Request body

agentIdstring uuid required
messagestring required

Example request

{
  "agentId": "cc3fd192-ea62-11f0-99fd-03d6b2458fff",
  "message": "What documents do we have about Q4 planning?",
  "conversation": {
    "type": "new",
    "dataInputVariableSelections": null
  }
}

Response

Message sent successfully

jobIdstring required

Example response

{
  "jobId": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}

Changes

Changed in 3 of the 5 revisions of this API.3