Vorsto Docs
  • Get Started
  • Getting Started
    • Create Agent
    • Configure Agent
    • Functions
    • Parameters
  • API
    • Authentication
    • Request
    • Object Response
    • Text Response
    • API Web Hook
    • IP Whitelisting
  • 3rd Party Models
    • GPT
    • Gemini
Powered by GitBook
On this page

Was this helpful?

  1. API

Text Response

Text responses allow functions to be configured and your Agent responses are not returned when you call the api. The request code (message id) is returned for you track the response of your request on the api web hook for recounciliation.

Text response also returns an history of the requests for context understanding.

//API Text Response
{
    "message": {
        "id": "duH7f5mOItDIlpYRbMPDE",
        "message": "your agent is processing your request."
    }
}
// Webhook Text Response
{
    "message": {
        "id": "duH7f5mOItDIlpYRbMPDE",
        "agentId": "hyeyry3mOItehdsfp373hhs",
        "role": "assistant",
        "content": "The diagnosis of Pediculus Capitis (head lice) is a valid medical condition. The details provided do not indicate any fraudulent activity."
    }
}

Text response are not returned with the api response. Text responses are returned as string in the "content" response object to your configured webhook url.

PreviousObject ResponseNextAPI Web Hook

Last updated 7 months ago

Was this helpful?