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.
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 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" }]