Skip to main content
POST
/
agents
/
{id}
/
query
Query agents
curl --request POST \
  --url https://app.docs.bynesoft.com/api/ask/agents/{id}/query \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "conversation": {
    "id": "<string>",
    "priorMessagesCount": 2
  }
}'
{
  "queryId": "<string>",
  "conversationId": "<string>",
  "response": {
    "answer": "<string>",
    "reference": [
      {
        "exeLayer": "<string>",
        "source": "<string>",
        "title": "<string>"
      }
    ]
  }
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string
required

Query Parameters

​
q
string
required
​
withReference
boolean
default:false
​
stream
boolean
default:false

Streaming with response blocking Output GuardRails is forbidden

Body

application/json
​
conversation
object | null

Response

Successful Response

  • AskAgentResponseBodyWithResponse
  • AskAgentResponseBodyWithTriggeredGuardRailes
  • AskAgentResponseBodyWithTriggeredFailGuardRailes
​
queryId
string
required
​
conversationId
string
required
​
response
object
required
  • AgentResponseItemWithRef
  • AgentResponseItemWithoutRef
⌘I