Get data for a specific guide
Retrieves details of a specific guide. While the guide is being created, the endpoint returns 202 (poll again later). If the creation failed permanently (explicit terminal flag, or a failure older than 15 minutes with no retry left, see progressStatus.terminalInferred), it returns 200 with success=false, status=failed, a human-readable French error message, creationFailed=true, refunded (whether the consumed credits were automatically given back) and guide.progressStatus (raw reason, message, terminal, kind, and failureFacts when the figures are known, which is only possible for sources whose web pages we read, that is a search engine or a _CITATIONS source, never a source in answer mode). Stop polling in that case.
Request
- Base URL: https://app.serpmantics.com (the document declares no server; this is the origin it was published from)
- URL: https://app.serpmantics.com/api/v1/guide
- Auth: HTTP bearer
Query parameters
The ID of the guide to retrieve
Response
Guide successfully retrieved, or guide creation failed permanently (success=false, status=failed)
Example response
{
"success": true,
"guide": {
"shareState": "private",
"shareUrl": "https://app.serpmantics.com/6a8e660408106ac39f4f6261/edit",
"corpusTopWindow": {
"fallback": true,
"maxPosition": 22,
"documents": 3
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.