Ask Owlbot AI a question

Ask Owlbot a question about the content of your docs.

Log in to see full request history

⚠️

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" }]
Body Params
string
required

The question being asked to Owlbot.

boolean

If true the response will be streamed as it is generated.

Response

Response body
object
string
array of objects
sources
object
string

The page title for the given source.

string

A link to the source.

Language
Credentials
:
Click Try It! to start a request and see the response here! Or choose an example:
text/event-stream
application/json