During your agent workflow, you may want to show some output to the human user. We provide an API for that:

curl -X POST https://api.agentreach.ai/v1/session/agent/send-message-to-human \
  -H "Authorization: Bearer <Agent API Key>" \
  -H "Content-Type: application/json" \
  -d '{"sessionId": "<sessionId>", "message": "<message>"}'

The API returns a JSON object with the following fields:

{
    "shouldRetry": boolean
}
  • If this is set to true, it means you should retry this API. You do not need to wait before retrying since the API does some waiting itself. This is usually true when there is a delay in the queuing system for the communication channel being used.
  • If this is set to false, it means the message has been sent to the human (though it may not yet have been delivered, in case of email, and / or still may be unread by the human).

Handling error status codes:

  • It can also return a 400 status code if the session is in a different state (like waiting for a human response, or is still waiting to send a previous message). Therefore, we recommend that you only continue your agent workflow once the API has returned a 200 status code, and not to call this API in the background of your agent workflow.
  • If the API returns a 5xx error, or is down, then you should wait for up to 1 second and try again.