Ask an Assistant a question; get its published answer with the Sources it cited (conversationId continues a thread)

POST/api/v1/assistants/{id}/ask

Requires an Organization API key with the member capability.

Authorization

apiKey

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

question*string

Length1 <= length <= 4000

conversationId?string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/assistants/string/ask" \  -H "Content-Type: application/json" \  -d '{    "question": "string"  }'

{  "conversationId": null,  "messageId": null,  "flowName": null,  "answer": "string",  "sources": [    {      "documentId": null,      "documentTitle": "string",      "sourceId": null,      "sourceName": null,      "collectionName": "string",      "url": null    }  ],  "error": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

Ask an Assistant a question; get its published answer with the Sources it cited (conversationId continues a thread)

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

409application/json

422application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`