Skip to main content
Use this endpoint to perform semantic searches across your documentation. The search API uses AI to understand the intent behind queries and return relevant results based on meaning, not just keyword matching.

​
Use cases

  • Build custom search interfaces for your documentation
  • Integrate documentation search into your application
  • Create AI-powered chatbots that can search your docs
  • Implement context-aware help systems

​
Search behavior

The search endpoint:
  • Performs semantic search using AI to understand query intent
  • Returns results ranked by relevance
  • Searches across all indexed pages in your documentation
  • Respects your documentation’s navigation structure
  • Provides context snippets for each result

​
Best practices

  • Use natural language queries for best results
  • Be specific rather than vague (e.g., “How do I authenticate API requests?” vs “auth”)
  • Include context when needed (e.g., “Python SDK installation” vs “installation”)
  • Display result titles and descriptions to help users identify relevant content
  • Include context snippets to show why results matched
  • Provide direct links to full pages for detailed information
  • Consider implementing pagination for large result sets
  • Implement search suggestions or autocomplete
  • Show recent or popular searches
  • Provide filters for result types or categories
  • Track search analytics to understand user needs