Get guide recommendations for an issue

Analyzes an issue/subproblem and returns recommended guides with relevance scores. Uses the AI Agent recommendation pipeline including query expansion, semantic search, keyword search, re-ranking, and a minimum relevance score per guide.

post/ai/recommendGuides

Request

Base URL
https://public.stonly.com/api/v3
Auth
HTTP basic

Request body

kbIdinteger required

Knowledge Base ID to search within

tagFilterstring[]

Tag IDs to filter search results. Only applied if searchFiltersEnabled is true in AI agent configuration.

includeDebugboolean

Include timing and query debug information in the response

Example request

{
  "issues": {
    "raisedIssues": [
      {
        "issue": "Trigger is not showing up despite enabling the Stonly extension"
      }
    ]
  }
}

Response

Successful guide recommendation response

Example response

{
  "results": [
    {
      "issue": "Trigger is not showing up despite enabling the Stonly extension",
      "guides": [
        {
          "guideId": "ULCR6fsl0C",
          "guideType": "GUIDE",
          "stepId": 3864161,
          "stepTitle": "Type of trigger",
          "title": "Stonly Widget troubleshooting guide",
          "type": "keyword",
          "score": 0.85
        }
      ],
      "verdict": true,
      "explanation": "At least one guide scored at or above the relevance floor."
    }
  ],
  "debug": {
    "queryExpansionTime": 1234,
    "searchTime": 567,
    "issueCount": 2
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.