Ask Owlbot a question about the content of your docs.
API v1 and this route are not available to projects that are using ReadMe Refactored. Check out our API migration guide for information on how to migrate to the new API.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Enterprise OnlyAsking a question to Owlbot AI via the API is only available to projects on our Enterprise plan. Contact [email protected] to learn more!
Streaming Response
By setting the accept header to text/event-stream, this endpoint streams the answer as it is generated instead of waiting for the entire response to be complete. This makes UI elements rendering this content feel much more responsive, since it can take several seconds to get the entire response otherwise.
The response is streamed as plain-text Markdown, not Server-Sent Events, so EventSource will not work. Read the raw body instead. When sources were used, the stream ends with a blank line and a sources: line holding a JSON array of { title, url }.
sources: [{ "title": "Page Title", "url": "https://docs.example.com/docs/source" }]