Ask Owlbot AI a question

post https://dash.readme.com/api/v1/owlbot/ask

Ask Owlbot a question about the content of your docs.

⚠️
Enterprise Only
Asking a question to Owlbot AI via the API is only available to projects on our Enterprise plan. Contact growth@readme.io to learn more!

Streaming Response

By passing in stream: true to the POST request this endpoint will send back data as it is generated instead of waiting for the entire response to be complete. This will make UI elements rendering this content feel much more responsive, cause it can take several seconds to get the entire response otherwise.

For streaming responses we always return the sources used as the first chunk in the following format, followed by two newline characters.

sources: [{ title: "Page Title" url: "https://docs.example.com/docs/source" }]

Response

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request POST \
2
     --url https://dash.readme.com/api/v1/owlbot/ask \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

text/event-stream

application/json

⚠️Enterprise Only

Streaming Response

200The answer to the question that was asked.

⚠️
Enterprise Only